@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +11 -11
- package/sdk/application/Cart/CartApplicationClient.js +48 -50
- package/sdk/application/Content/ContentApplicationClient.d.ts +0 -20
- package/sdk/application/Content/ContentApplicationClient.js +0 -78
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.js +2 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +10 -0
- package/sdk/application/Payment/PaymentApplicationClient.js +39 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -12
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +209 -38
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +399 -19
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +212 -11
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +3 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +22 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +3 -12
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +0 -7
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +0 -3
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -14
- package/sdk/platform/Cart/CartPlatformModel.js +12 -6
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +24 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.js +176 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +80 -29
- package/sdk/platform/Catalog/CatalogPlatformModel.js +72 -32
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +45 -1
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +35 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -52
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -411
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -85
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -73
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1 -90
- package/sdk/platform/Content/ContentPlatformModel.js +0 -104
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +8 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +75 -3
- package/sdk/platform/Order/OrderPlatformModel.js +43 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +10 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +94 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +699 -76
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +598 -23
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +382 -20
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +134 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +108 -0
|
@@ -78,6 +78,8 @@ const Joi = require("joi");
|
|
|
78
78
|
* first-mile service is available or not.
|
|
79
79
|
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
80
80
|
* service is available or not.
|
|
81
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
82
|
+
* region is first-mile serviceable or not in return pickup.
|
|
81
83
|
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
82
84
|
* (COD) payments allowed in the specified region.
|
|
83
85
|
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
@@ -99,6 +101,8 @@ const Joi = require("joi");
|
|
|
99
101
|
* first-mile service is available or not.
|
|
100
102
|
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
101
103
|
* service is available or not.
|
|
104
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
105
|
+
* region is first-mile serviceable or not in return pickup.
|
|
102
106
|
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
103
107
|
* (COD) payments allowed in the specified region.
|
|
104
108
|
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
@@ -129,6 +133,8 @@ const Joi = require("joi");
|
|
|
129
133
|
* first-mile service is available or not.
|
|
130
134
|
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
131
135
|
* service is available or not.
|
|
136
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
137
|
+
* region is first-mile serviceable or not in return pickup.
|
|
132
138
|
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
133
139
|
* (COD) payments allowed in the specified region.
|
|
134
140
|
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
@@ -160,6 +166,8 @@ const Joi = require("joi");
|
|
|
160
166
|
* first-mile service is available or not.
|
|
161
167
|
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
162
168
|
* service is available or not.
|
|
169
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
170
|
+
* region is first-mile serviceable or not in return pickup.
|
|
163
171
|
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
164
172
|
* (COD) payments allowed in the specified region.
|
|
165
173
|
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
@@ -331,8 +339,8 @@ const Joi = require("joi");
|
|
|
331
339
|
* courier partner scheme.
|
|
332
340
|
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
333
341
|
* courier partner scheme.
|
|
334
|
-
* @property {string} stage -
|
|
335
|
-
*
|
|
342
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
343
|
+
* currently active or inactive.
|
|
336
344
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
337
345
|
*/
|
|
338
346
|
|
|
@@ -350,8 +358,8 @@ const Joi = require("joi");
|
|
|
350
358
|
* courier partner scheme.
|
|
351
359
|
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
352
360
|
* courier partner scheme.
|
|
353
|
-
* @property {string} stage -
|
|
354
|
-
*
|
|
361
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
362
|
+
* currently active or inactive.
|
|
355
363
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
356
364
|
*/
|
|
357
365
|
|
|
@@ -400,6 +408,106 @@ const Joi = require("joi");
|
|
|
400
408
|
* quantity of items allowed in a non-quality check shipment.
|
|
401
409
|
*/
|
|
402
410
|
|
|
411
|
+
/**
|
|
412
|
+
* @typedef CourierPartnerSchemeV2Features
|
|
413
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
414
|
+
* doorstep quality check services.
|
|
415
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
416
|
+
* code-based operations.
|
|
417
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
418
|
+
* multi-part shipment services.
|
|
419
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
420
|
+
* feature is supported by the courier partner.
|
|
421
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
422
|
+
* handles the transportation of dangerous goods.
|
|
423
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
424
|
+
* manages the shipment of fragile goods.
|
|
425
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
426
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
427
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
428
|
+
* provides cold storage facilities for goods.
|
|
429
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
430
|
+
* supports doorstep exchange services.
|
|
431
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
432
|
+
* offers doorstep return services.
|
|
433
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
434
|
+
* provides product installation services upon delivery.
|
|
435
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
436
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
437
|
+
* before accepting.
|
|
438
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
439
|
+
* partner supports multiple pickups to a single drop location.
|
|
440
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
441
|
+
* partner supports single pickup to multiple drop locations.
|
|
442
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
443
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
444
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
445
|
+
* supports the generation of e-waybills for shipments.
|
|
446
|
+
*/
|
|
447
|
+
|
|
448
|
+
/**
|
|
449
|
+
* @typedef CourierPartnerSchemeV2DetailsModel
|
|
450
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
451
|
+
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
452
|
+
* @property {string} name - Name of the scheme.
|
|
453
|
+
* @property {ArithmeticOperations} weight
|
|
454
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
455
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
456
|
+
* courier partner scheme.
|
|
457
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
458
|
+
* partner scheme.
|
|
459
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
460
|
+
* courier partner scheme.
|
|
461
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
462
|
+
* courier partner scheme.
|
|
463
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
464
|
+
* currently active or inactive.
|
|
465
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
466
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
467
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
468
|
+
* (NDR) feature is supported by the courier partner.
|
|
469
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
470
|
+
* of items allowed in a quality check shipment.
|
|
471
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
472
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
473
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
474
|
+
*/
|
|
475
|
+
|
|
476
|
+
/**
|
|
477
|
+
* @typedef CourierPartnerV2SchemeModel
|
|
478
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
479
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
480
|
+
* @property {string} [company_id] - Unique identifier of company.
|
|
481
|
+
* @property {string} name - Name of the scheme.
|
|
482
|
+
* @property {ArithmeticOperations} weight
|
|
483
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
484
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
485
|
+
* courier partner scheme.
|
|
486
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
487
|
+
* partner scheme.
|
|
488
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
489
|
+
* courier partner scheme.
|
|
490
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
491
|
+
* courier partner scheme.
|
|
492
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
493
|
+
* currently active or inactive.
|
|
494
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
495
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
496
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
497
|
+
* (NDR) feature is supported by the courier partner.
|
|
498
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
499
|
+
* of items allowed in a quality check shipment.
|
|
500
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
501
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
502
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
503
|
+
*/
|
|
504
|
+
|
|
505
|
+
/**
|
|
506
|
+
* @typedef courierPartnerSchemeV2List
|
|
507
|
+
* @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
|
|
508
|
+
* @property {Page} page
|
|
509
|
+
*/
|
|
510
|
+
|
|
403
511
|
/**
|
|
404
512
|
* @typedef ArithmeticOperations
|
|
405
513
|
* @property {number} [lt]
|
|
@@ -409,9 +517,10 @@ const Joi = require("joi");
|
|
|
409
517
|
*/
|
|
410
518
|
|
|
411
519
|
/**
|
|
412
|
-
* @typedef
|
|
520
|
+
* @typedef CourierPartnerSchemeV2UpdateDetails
|
|
413
521
|
* @property {string} name - Name of the scheme.
|
|
414
522
|
* @property {ArithmeticOperations} weight
|
|
523
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
415
524
|
* @property {string} transport_type - Mode of transport associated with the
|
|
416
525
|
* courier partner scheme.
|
|
417
526
|
* @property {string} region - Serviceable region associated with the courier
|
|
@@ -420,9 +529,17 @@ const Joi = require("joi");
|
|
|
420
529
|
* courier partner scheme.
|
|
421
530
|
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
422
531
|
* courier partner scheme.
|
|
423
|
-
* @property {string} stage -
|
|
424
|
-
*
|
|
425
|
-
* @property {
|
|
532
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
533
|
+
* currently active or inactive.
|
|
534
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
535
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
536
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
537
|
+
* (NDR) feature is supported by the courier partner.
|
|
538
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
539
|
+
* of items allowed in a quality check shipment.
|
|
540
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
541
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
542
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
426
543
|
*/
|
|
427
544
|
|
|
428
545
|
/**
|
|
@@ -573,6 +690,7 @@ class LogisticsPartnerModel {
|
|
|
573
690
|
return Joi.object({
|
|
574
691
|
first_mile: Joi.boolean(),
|
|
575
692
|
last_mile: Joi.boolean(),
|
|
693
|
+
reverse_pickup: Joi.boolean().allow(null),
|
|
576
694
|
cod_limit: Joi.number(),
|
|
577
695
|
doorstep_return: Joi.boolean(),
|
|
578
696
|
doorstep_qc: Joi.boolean(),
|
|
@@ -587,6 +705,7 @@ class LogisticsPartnerModel {
|
|
|
587
705
|
return Joi.object({
|
|
588
706
|
first_mile: Joi.boolean(),
|
|
589
707
|
last_mile: Joi.boolean(),
|
|
708
|
+
reverse_pickup: Joi.boolean().allow(null),
|
|
590
709
|
cod_limit: Joi.number(),
|
|
591
710
|
doorstep_return: Joi.boolean(),
|
|
592
711
|
doorstep_qc: Joi.boolean(),
|
|
@@ -605,6 +724,7 @@ class LogisticsPartnerModel {
|
|
|
605
724
|
pincode: Joi.string().allow(""),
|
|
606
725
|
first_mile: Joi.boolean(),
|
|
607
726
|
last_mile: Joi.boolean(),
|
|
727
|
+
reverse_pickup: Joi.boolean().allow(null),
|
|
608
728
|
cod_limit: Joi.number(),
|
|
609
729
|
doorstep_return: Joi.boolean(),
|
|
610
730
|
doorstep_qc: Joi.boolean(),
|
|
@@ -624,6 +744,7 @@ class LogisticsPartnerModel {
|
|
|
624
744
|
pincode: Joi.string().allow(""),
|
|
625
745
|
first_mile: Joi.boolean(),
|
|
626
746
|
last_mile: Joi.boolean(),
|
|
747
|
+
reverse_pickup: Joi.boolean().allow(null),
|
|
627
748
|
cod_limit: Joi.number(),
|
|
628
749
|
doorstep_return: Joi.boolean(),
|
|
629
750
|
doorstep_qc: Joi.boolean(),
|
|
@@ -826,6 +947,81 @@ class LogisticsPartnerModel {
|
|
|
826
947
|
});
|
|
827
948
|
}
|
|
828
949
|
|
|
950
|
+
/** @returns {CourierPartnerSchemeV2Features} */
|
|
951
|
+
static CourierPartnerSchemeV2Features() {
|
|
952
|
+
return Joi.object({
|
|
953
|
+
doorstep_qc: Joi.boolean(),
|
|
954
|
+
qr: Joi.boolean(),
|
|
955
|
+
mps: Joi.boolean(),
|
|
956
|
+
ndr: Joi.boolean(),
|
|
957
|
+
dangerous_goods: Joi.boolean(),
|
|
958
|
+
fragile_goods: Joi.boolean(),
|
|
959
|
+
restricted_goods: Joi.boolean(),
|
|
960
|
+
cold_storage_goods: Joi.boolean(),
|
|
961
|
+
doorstep_exchange: Joi.boolean(),
|
|
962
|
+
doorstep_return: Joi.boolean(),
|
|
963
|
+
product_installation: Joi.boolean(),
|
|
964
|
+
openbox_delivery: Joi.boolean(),
|
|
965
|
+
multi_pick_single_drop: Joi.boolean(),
|
|
966
|
+
single_pick_multi_drop: Joi.boolean(),
|
|
967
|
+
multi_pick_multi_drop: Joi.boolean(),
|
|
968
|
+
ewaybill: Joi.boolean(),
|
|
969
|
+
});
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/** @returns {CourierPartnerSchemeV2DetailsModel} */
|
|
973
|
+
static CourierPartnerSchemeV2DetailsModel() {
|
|
974
|
+
return Joi.object({
|
|
975
|
+
extension_id: Joi.string().allow("").required(),
|
|
976
|
+
scheme_id: Joi.string().allow(""),
|
|
977
|
+
name: Joi.string().allow("").required(),
|
|
978
|
+
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
979
|
+
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
980
|
+
transport_type: Joi.string().allow("").required(),
|
|
981
|
+
region: Joi.string().allow("").required(),
|
|
982
|
+
delivery_type: Joi.string().allow("").required(),
|
|
983
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
984
|
+
stage: Joi.string().allow("").required(),
|
|
985
|
+
status_updates: Joi.string().allow(""),
|
|
986
|
+
ndr_attempts: Joi.number(),
|
|
987
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
988
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
989
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeV2Features().required(),
|
|
990
|
+
});
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
/** @returns {CourierPartnerV2SchemeModel} */
|
|
994
|
+
static CourierPartnerV2SchemeModel() {
|
|
995
|
+
return Joi.object({
|
|
996
|
+
extension_id: Joi.string().allow("").required(),
|
|
997
|
+
scheme_id: Joi.string().allow("").required(),
|
|
998
|
+
company_id: Joi.string().allow(""),
|
|
999
|
+
name: Joi.string().allow("").required(),
|
|
1000
|
+
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
1001
|
+
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
1002
|
+
transport_type: Joi.string().allow("").required(),
|
|
1003
|
+
region: Joi.string().allow("").required(),
|
|
1004
|
+
delivery_type: Joi.string().allow("").required(),
|
|
1005
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
1006
|
+
stage: Joi.string().allow("").required(),
|
|
1007
|
+
status_updates: Joi.string().allow(""),
|
|
1008
|
+
ndr_attempts: Joi.number(),
|
|
1009
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1010
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1011
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeV2Features().required(),
|
|
1012
|
+
});
|
|
1013
|
+
}
|
|
1014
|
+
|
|
1015
|
+
/** @returns {courierPartnerSchemeV2List} */
|
|
1016
|
+
static courierPartnerSchemeV2List() {
|
|
1017
|
+
return Joi.object({
|
|
1018
|
+
items: Joi.array()
|
|
1019
|
+
.items(LogisticsPartnerModel.CourierPartnerV2SchemeModel())
|
|
1020
|
+
.required(),
|
|
1021
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
1022
|
+
});
|
|
1023
|
+
}
|
|
1024
|
+
|
|
829
1025
|
/** @returns {ArithmeticOperations} */
|
|
830
1026
|
static ArithmeticOperations() {
|
|
831
1027
|
return Joi.object({
|
|
@@ -836,17 +1032,22 @@ class LogisticsPartnerModel {
|
|
|
836
1032
|
});
|
|
837
1033
|
}
|
|
838
1034
|
|
|
839
|
-
/** @returns {
|
|
840
|
-
static
|
|
1035
|
+
/** @returns {CourierPartnerSchemeV2UpdateDetails} */
|
|
1036
|
+
static CourierPartnerSchemeV2UpdateDetails() {
|
|
841
1037
|
return Joi.object({
|
|
842
1038
|
name: Joi.string().allow("").required(),
|
|
843
1039
|
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
1040
|
+
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
844
1041
|
transport_type: Joi.string().allow("").required(),
|
|
845
1042
|
region: Joi.string().allow("").required(),
|
|
846
1043
|
delivery_type: Joi.string().allow("").required(),
|
|
847
1044
|
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
848
1045
|
stage: Joi.string().allow("").required(),
|
|
849
|
-
|
|
1046
|
+
status_updates: Joi.string().allow(""),
|
|
1047
|
+
ndr_attempts: Joi.number(),
|
|
1048
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1049
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1050
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeV2Features().required(),
|
|
850
1051
|
});
|
|
851
1052
|
}
|
|
852
1053
|
|
|
@@ -20,7 +20,9 @@ declare class LogisticsValidator {
|
|
|
20
20
|
static getCourierPartnerAccounts(): any;
|
|
21
21
|
static updateCourierPartnerAccount(): any;
|
|
22
22
|
static getCourierPartnerAccount(): any;
|
|
23
|
+
static getCountries(): any;
|
|
23
24
|
static createCourierPartnerScheme(): any;
|
|
25
|
+
static getCourierPartnerSchemes(): any;
|
|
24
26
|
static updateCourierPartnerScheme(): any;
|
|
25
|
-
static
|
|
27
|
+
static getCourierPartnerScheme(): any;
|
|
26
28
|
}
|
|
@@ -211,25 +211,40 @@ class LogisticsValidator {
|
|
|
211
211
|
}).required();
|
|
212
212
|
}
|
|
213
213
|
|
|
214
|
+
static getCountries() {
|
|
215
|
+
return Joi.object({
|
|
216
|
+
onboarding: Joi.boolean(),
|
|
217
|
+
pageNo: Joi.number(),
|
|
218
|
+
pageSize: Joi.number(),
|
|
219
|
+
q: Joi.string().allow(""),
|
|
220
|
+
}).required();
|
|
221
|
+
}
|
|
222
|
+
|
|
214
223
|
static createCourierPartnerScheme() {
|
|
215
224
|
return Joi.object({
|
|
216
|
-
body: LogisticsModel.
|
|
225
|
+
body: LogisticsModel.CourierPartnerSchemeV2DetailsModel().required(),
|
|
226
|
+
}).required();
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
static getCourierPartnerSchemes() {
|
|
230
|
+
return Joi.object({
|
|
231
|
+
schemeType: Joi.string().allow(""),
|
|
232
|
+
paymentMode: Joi.string().allow(""),
|
|
233
|
+
capabilities: Joi.array().items(Joi.string().allow("")),
|
|
234
|
+
schemeIds: Joi.array().items(Joi.string().allow("")),
|
|
217
235
|
}).required();
|
|
218
236
|
}
|
|
219
237
|
|
|
220
238
|
static updateCourierPartnerScheme() {
|
|
221
239
|
return Joi.object({
|
|
222
240
|
schemeId: Joi.string().allow("").required(),
|
|
223
|
-
body: LogisticsModel.
|
|
241
|
+
body: LogisticsModel.CourierPartnerSchemeV2UpdateDetails().required(),
|
|
224
242
|
}).required();
|
|
225
243
|
}
|
|
226
244
|
|
|
227
|
-
static
|
|
245
|
+
static getCourierPartnerScheme() {
|
|
228
246
|
return Joi.object({
|
|
229
|
-
|
|
230
|
-
pageNo: Joi.number(),
|
|
231
|
-
pageSize: Joi.number(),
|
|
232
|
-
q: Joi.string().allow(""),
|
|
247
|
+
schemeId: Joi.string().allow("").required(),
|
|
233
248
|
}).required();
|
|
234
249
|
}
|
|
235
250
|
}
|
|
@@ -83,7 +83,7 @@ class AnalyticsPlatformModel {
|
|
|
83
83
|
static JobStatus() {
|
|
84
84
|
return Joi.object({
|
|
85
85
|
start_date: Joi.string().allow(""),
|
|
86
|
-
end_date: Joi.string().allow(""),
|
|
86
|
+
end_date: Joi.string().allow("").allow(null),
|
|
87
87
|
status: Joi.string().allow(""),
|
|
88
88
|
message: Joi.string().allow(""),
|
|
89
89
|
file_metadata: Joi.array().items(Joi.any()).allow(null, ""),
|
|
@@ -360,7 +360,7 @@ declare class Cart {
|
|
|
360
360
|
* @summary: List of all available promotion offers
|
|
361
361
|
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
|
|
362
362
|
*/
|
|
363
|
-
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType,
|
|
363
|
+
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionOffersDetails>;
|
|
364
364
|
/**
|
|
365
365
|
* @param {CartPlatformApplicationValidator.GetPromotionPaymentOffersParam} arg
|
|
366
366
|
* - Arg object
|
|
@@ -2841,15 +2841,9 @@ class Cart {
|
|
|
2841
2841
|
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
|
|
2842
2842
|
*/
|
|
2843
2843
|
async getPromotionOffers(
|
|
2844
|
-
{
|
|
2845
|
-
|
|
2846
|
-
|
|
2847
|
-
promotionGroup,
|
|
2848
|
-
storeId,
|
|
2849
|
-
cartType,
|
|
2850
|
-
sortBy,
|
|
2851
|
-
requestHeaders,
|
|
2852
|
-
} = { requestHeaders: {} },
|
|
2844
|
+
{ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders } = {
|
|
2845
|
+
requestHeaders: {},
|
|
2846
|
+
},
|
|
2853
2847
|
{ responseHeaders } = { responseHeaders: false }
|
|
2854
2848
|
) {
|
|
2855
2849
|
const {
|
|
@@ -2861,7 +2855,6 @@ class Cart {
|
|
|
2861
2855
|
promotionGroup,
|
|
2862
2856
|
storeId,
|
|
2863
2857
|
cartType,
|
|
2864
|
-
sortBy,
|
|
2865
2858
|
},
|
|
2866
2859
|
{ abortEarly: false, allowUnknown: true }
|
|
2867
2860
|
);
|
|
@@ -2879,7 +2872,6 @@ class Cart {
|
|
|
2879
2872
|
promotionGroup,
|
|
2880
2873
|
storeId,
|
|
2881
2874
|
cartType,
|
|
2882
|
-
sortBy,
|
|
2883
2875
|
},
|
|
2884
2876
|
{ abortEarly: false, allowUnknown: false }
|
|
2885
2877
|
);
|
|
@@ -2896,7 +2888,6 @@ class Cart {
|
|
|
2896
2888
|
query_params["promotion_group"] = promotionGroup;
|
|
2897
2889
|
query_params["store_id"] = storeId;
|
|
2898
2890
|
query_params["cart_type"] = cartType;
|
|
2899
|
-
query_params["sort_by"] = sortBy;
|
|
2900
2891
|
|
|
2901
2892
|
const response = await PlatformAPIClient.execute(
|
|
2902
2893
|
this.config,
|
|
@@ -197,8 +197,6 @@ export = CartPlatformApplicationValidator;
|
|
|
197
197
|
* @property {string} [promotionGroup] - Type of promotion groups
|
|
198
198
|
* @property {number} [storeId] - Unique identifier of a store
|
|
199
199
|
* @property {string} [cartType] - The type of cart
|
|
200
|
-
* @property {string} [sortBy] - Specifies the sorting criteria for the
|
|
201
|
-
* promotions. Sorts promotions in descending order by the value provided.
|
|
202
200
|
*/
|
|
203
201
|
/**
|
|
204
202
|
* @typedef GetPromotionPaymentOffersParam
|
|
@@ -756,11 +754,6 @@ type GetPromotionOffersParam = {
|
|
|
756
754
|
* - The type of cart
|
|
757
755
|
*/
|
|
758
756
|
cartType?: string;
|
|
759
|
-
/**
|
|
760
|
-
* - Specifies the sorting criteria for the
|
|
761
|
-
* promotions. Sorts promotions in descending order by the value provided.
|
|
762
|
-
*/
|
|
763
|
-
sortBy?: string;
|
|
764
757
|
};
|
|
765
758
|
type GetPromotionPaymentOffersParam = {
|
|
766
759
|
/**
|
|
@@ -233,8 +233,6 @@ const CartPlatformModel = require("./CartPlatformModel");
|
|
|
233
233
|
* @property {string} [promotionGroup] - Type of promotion groups
|
|
234
234
|
* @property {number} [storeId] - Unique identifier of a store
|
|
235
235
|
* @property {string} [cartType] - The type of cart
|
|
236
|
-
* @property {string} [sortBy] - Specifies the sorting criteria for the
|
|
237
|
-
* promotions. Sorts promotions in descending order by the value provided.
|
|
238
236
|
*/
|
|
239
237
|
|
|
240
238
|
/**
|
|
@@ -762,7 +760,6 @@ class CartPlatformApplicationValidator {
|
|
|
762
760
|
promotionGroup: Joi.string().allow(""),
|
|
763
761
|
storeId: Joi.number(),
|
|
764
762
|
cartType: Joi.string().allow(""),
|
|
765
|
-
sortBy: Joi.string().allow(""),
|
|
766
763
|
}).required();
|
|
767
764
|
}
|
|
768
765
|
|
|
@@ -1000,8 +1000,6 @@ export = CartPlatformModel;
|
|
|
1000
1000
|
* @property {BuyRules[]} [buy_rules] - Buy rules for promotions
|
|
1001
1001
|
* @property {string} [offer_text] - Offer text of current promotion
|
|
1002
1002
|
* @property {number} [amount] - Per unit discount amount applied with current promotion
|
|
1003
|
-
* @property {string} [float_amount] - Per unit discount amount with decimal
|
|
1004
|
-
* values applied with current promotion.
|
|
1005
1003
|
* @property {string} [promotion_type] - Promotion type of current promotion
|
|
1006
1004
|
* @property {boolean} [mrp_promotion] - If applied promotion is applied on
|
|
1007
1005
|
* product MRP or ESP
|
|
@@ -1970,6 +1968,10 @@ export = CartPlatformModel;
|
|
|
1970
1968
|
* @property {string} [network]
|
|
1971
1969
|
* @property {string} [type]
|
|
1972
1970
|
* @property {string} [card_id]
|
|
1971
|
+
* @property {string} [success_callback_url] - Success callback url to be
|
|
1972
|
+
* redirected after payment received
|
|
1973
|
+
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
1974
|
+
* redirected after payment failed
|
|
1973
1975
|
*/
|
|
1974
1976
|
/**
|
|
1975
1977
|
* @typedef CheckCart
|
|
@@ -2168,6 +2170,10 @@ export = CartPlatformModel;
|
|
|
2168
2170
|
* the payment
|
|
2169
2171
|
* @property {string} [type] - Type of cart if payment mode is card to do the payment
|
|
2170
2172
|
* @property {string} [card_id] - Saved card id if payment mode is card to do the payment
|
|
2173
|
+
* @property {string} [success_callback_url] - Success callback url to be
|
|
2174
|
+
* redirected after payment received
|
|
2175
|
+
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
2176
|
+
* redirected after payment failed
|
|
2171
2177
|
*/
|
|
2172
2178
|
/**
|
|
2173
2179
|
* @typedef UpdateCartPaymentRequestV2
|
|
@@ -2227,8 +2233,6 @@ export = CartPlatformModel;
|
|
|
2227
2233
|
* @property {Object[]} [discount_rules] - Discount rules of promotions
|
|
2228
2234
|
* @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
|
|
2229
2235
|
* @property {string} [description] - Offer details including T&C
|
|
2230
|
-
* @property {boolean} [is_bank_offer] - Indicates whether the promotion is
|
|
2231
|
-
* associated with a bank offer.
|
|
2232
2236
|
*/
|
|
2233
2237
|
/**
|
|
2234
2238
|
* @typedef PromotionOffersDetails
|
|
@@ -4717,11 +4721,6 @@ type AppliedPromotion = {
|
|
|
4717
4721
|
* - Per unit discount amount applied with current promotion
|
|
4718
4722
|
*/
|
|
4719
4723
|
amount?: number;
|
|
4720
|
-
/**
|
|
4721
|
-
* - Per unit discount amount with decimal
|
|
4722
|
-
* values applied with current promotion.
|
|
4723
|
-
*/
|
|
4724
|
-
float_amount?: string;
|
|
4725
4724
|
/**
|
|
4726
4725
|
* - Promotion type of current promotion
|
|
4727
4726
|
*/
|
|
@@ -7190,6 +7189,16 @@ type PlatformCartCheckoutDetailCreation = {
|
|
|
7190
7189
|
network?: string;
|
|
7191
7190
|
type?: string;
|
|
7192
7191
|
card_id?: string;
|
|
7192
|
+
/**
|
|
7193
|
+
* - Success callback url to be
|
|
7194
|
+
* redirected after payment received
|
|
7195
|
+
*/
|
|
7196
|
+
success_callback_url?: string;
|
|
7197
|
+
/**
|
|
7198
|
+
* - Failure callback url to be
|
|
7199
|
+
* redirected after payment failed
|
|
7200
|
+
*/
|
|
7201
|
+
failure_callback_url?: string;
|
|
7193
7202
|
};
|
|
7194
7203
|
/** @returns {CheckCart} */
|
|
7195
7204
|
declare function CheckCart(): CheckCart;
|
|
@@ -7718,6 +7727,16 @@ type PlatformCartCheckoutDetailV2Creation = {
|
|
|
7718
7727
|
* - Saved card id if payment mode is card to do the payment
|
|
7719
7728
|
*/
|
|
7720
7729
|
card_id?: string;
|
|
7730
|
+
/**
|
|
7731
|
+
* - Success callback url to be
|
|
7732
|
+
* redirected after payment received
|
|
7733
|
+
*/
|
|
7734
|
+
success_callback_url?: string;
|
|
7735
|
+
/**
|
|
7736
|
+
* - Failure callback url to be
|
|
7737
|
+
* redirected after payment failed
|
|
7738
|
+
*/
|
|
7739
|
+
failure_callback_url?: string;
|
|
7721
7740
|
};
|
|
7722
7741
|
/** @returns {UpdateCartPaymentRequestV2} */
|
|
7723
7742
|
declare function UpdateCartPaymentRequestV2(): UpdateCartPaymentRequestV2;
|
|
@@ -7867,11 +7886,6 @@ type PromotionOffer = {
|
|
|
7867
7886
|
* - Offer details including T&C
|
|
7868
7887
|
*/
|
|
7869
7888
|
description?: string;
|
|
7870
|
-
/**
|
|
7871
|
-
* - Indicates whether the promotion is
|
|
7872
|
-
* associated with a bank offer.
|
|
7873
|
-
*/
|
|
7874
|
-
is_bank_offer?: boolean;
|
|
7875
7889
|
};
|
|
7876
7890
|
/** @returns {PromotionOffersDetails} */
|
|
7877
7891
|
declare function PromotionOffersDetails(): PromotionOffersDetails;
|
|
@@ -1096,8 +1096,6 @@ const Joi = require("joi");
|
|
|
1096
1096
|
* @property {BuyRules[]} [buy_rules] - Buy rules for promotions
|
|
1097
1097
|
* @property {string} [offer_text] - Offer text of current promotion
|
|
1098
1098
|
* @property {number} [amount] - Per unit discount amount applied with current promotion
|
|
1099
|
-
* @property {string} [float_amount] - Per unit discount amount with decimal
|
|
1100
|
-
* values applied with current promotion.
|
|
1101
1099
|
* @property {string} [promotion_type] - Promotion type of current promotion
|
|
1102
1100
|
* @property {boolean} [mrp_promotion] - If applied promotion is applied on
|
|
1103
1101
|
* product MRP or ESP
|
|
@@ -2150,6 +2148,10 @@ const Joi = require("joi");
|
|
|
2150
2148
|
* @property {string} [network]
|
|
2151
2149
|
* @property {string} [type]
|
|
2152
2150
|
* @property {string} [card_id]
|
|
2151
|
+
* @property {string} [success_callback_url] - Success callback url to be
|
|
2152
|
+
* redirected after payment received
|
|
2153
|
+
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
2154
|
+
* redirected after payment failed
|
|
2153
2155
|
*/
|
|
2154
2156
|
|
|
2155
2157
|
/**
|
|
@@ -2360,6 +2362,10 @@ const Joi = require("joi");
|
|
|
2360
2362
|
* the payment
|
|
2361
2363
|
* @property {string} [type] - Type of cart if payment mode is card to do the payment
|
|
2362
2364
|
* @property {string} [card_id] - Saved card id if payment mode is card to do the payment
|
|
2365
|
+
* @property {string} [success_callback_url] - Success callback url to be
|
|
2366
|
+
* redirected after payment received
|
|
2367
|
+
* @property {string} [failure_callback_url] - Failure callback url to be
|
|
2368
|
+
* redirected after payment failed
|
|
2363
2369
|
*/
|
|
2364
2370
|
|
|
2365
2371
|
/**
|
|
@@ -2425,8 +2431,6 @@ const Joi = require("joi");
|
|
|
2425
2431
|
* @property {Object[]} [discount_rules] - Discount rules of promotions
|
|
2426
2432
|
* @property {FreeGiftItems[]} [free_gift_items] - Details of free gift items
|
|
2427
2433
|
* @property {string} [description] - Offer details including T&C
|
|
2428
|
-
* @property {boolean} [is_bank_offer] - Indicates whether the promotion is
|
|
2429
|
-
* associated with a bank offer.
|
|
2430
2434
|
*/
|
|
2431
2435
|
|
|
2432
2436
|
/**
|
|
@@ -3621,7 +3625,6 @@ class CartPlatformModel {
|
|
|
3621
3625
|
buy_rules: Joi.array().items(CartPlatformModel.BuyRules()),
|
|
3622
3626
|
offer_text: Joi.string().allow(""),
|
|
3623
3627
|
amount: Joi.number(),
|
|
3624
|
-
float_amount: Joi.string().allow(""),
|
|
3625
3628
|
promotion_type: Joi.string().allow(""),
|
|
3626
3629
|
mrp_promotion: Joi.boolean(),
|
|
3627
3630
|
promotion_group: Joi.string().allow(""),
|
|
@@ -4711,6 +4714,8 @@ class CartPlatformModel {
|
|
|
4711
4714
|
network: Joi.string().allow(""),
|
|
4712
4715
|
type: Joi.string().allow(""),
|
|
4713
4716
|
card_id: Joi.string().allow(""),
|
|
4717
|
+
success_callback_url: Joi.string().allow("").allow(null),
|
|
4718
|
+
failure_callback_url: Joi.string().allow("").allow(null),
|
|
4714
4719
|
});
|
|
4715
4720
|
}
|
|
4716
4721
|
|
|
@@ -4910,6 +4915,8 @@ class CartPlatformModel {
|
|
|
4910
4915
|
network: Joi.string().allow(""),
|
|
4911
4916
|
type: Joi.string().allow(""),
|
|
4912
4917
|
card_id: Joi.string().allow(""),
|
|
4918
|
+
success_callback_url: Joi.string().allow("").allow(null),
|
|
4919
|
+
failure_callback_url: Joi.string().allow("").allow(null),
|
|
4913
4920
|
});
|
|
4914
4921
|
}
|
|
4915
4922
|
|
|
@@ -4979,7 +4986,6 @@ class CartPlatformModel {
|
|
|
4979
4986
|
discount_rules: Joi.array().items(Joi.any()),
|
|
4980
4987
|
free_gift_items: Joi.array().items(CartPlatformModel.FreeGiftItems()),
|
|
4981
4988
|
description: Joi.string().allow(""),
|
|
4982
|
-
is_bank_offer: Joi.boolean(),
|
|
4983
4989
|
});
|
|
4984
4990
|
}
|
|
4985
4991
|
|