@gofynd/fdk-client-javascript 3.3.6 → 3.4.1

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 (54) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
  4. package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
  5. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
  6. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  7. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +115 -47
  8. package/sdk/partner/Logistics/LogisticsPartnerModel.js +67 -35
  9. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
  10. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
  11. package/sdk/platform/Cart/CartPlatformModel.d.ts +454 -12
  12. package/sdk/platform/Cart/CartPlatformModel.js +457 -10
  13. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  14. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
  15. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +9 -0
  16. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +4 -0
  17. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
  18. package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
  19. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
  20. package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
  21. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
  22. package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
  23. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  24. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  25. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
  26. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
  27. package/sdk/platform/Content/ContentPlatformModel.d.ts +14 -19
  28. package/sdk/platform/Content/ContentPlatformModel.js +6 -20
  29. package/sdk/platform/Order/OrderPlatformModel.d.ts +237 -17
  30. package/sdk/platform/Order/OrderPlatformModel.js +388 -14
  31. package/sdk/platform/Order/OrderPlatformValidator.d.ts +15 -15
  32. package/sdk/platform/Order/OrderPlatformValidator.js +9 -9
  33. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -5
  34. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +4 -3
  35. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +97 -1
  36. package/sdk/platform/Payment/PaymentPlatformModel.js +273 -0
  37. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
  38. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
  39. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
  40. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
  41. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
  42. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
  43. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1033 -113
  44. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +613 -35
  45. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
  46. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
  47. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
  48. package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
  49. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
  50. package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
  51. package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
  52. package/sdk/platform/User/UserPlatformModel.js +276 -7
  53. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
  54. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
@@ -9,7 +9,7 @@ const Joi = require("joi");
9
9
  * @property {string} [extension_id] - Unique identifier of courier partner extension.
10
10
  * @property {string} [scheme_id] - Unique identifier for the scheme, used to
11
11
  * fetch or modify scheme details.
12
- * @property {string} [company_id] - Unique identifier of company.
12
+ * @property {string} [company_id] - The unique identifier of the company.
13
13
  * @property {string} name - Name of the scheme.
14
14
  * @property {ArithmeticOperations} weight
15
15
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -32,6 +32,12 @@ const Joi = require("joi");
32
32
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
33
33
  * quantity of items allowed in a non-quality check shipment.
34
34
  * @property {CourierPartnerSchemeFeatures} feature
35
+ * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
36
+ * forward pickup (nullable), having 24hour time format HH:MM.
37
+ * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
38
+ * reverse pickup (nullable), having 24hour time format HH:MM.
39
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
40
+ * @property {CourierPartnerSchemeDefaultTat} [default_tat]
35
41
  */
36
42
 
37
43
  /**
@@ -382,9 +388,10 @@ const Joi = require("joi");
382
388
  * fetch or modify scheme details.
383
389
  * @property {string} name - Name of the scheme.
384
390
  * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
385
- * forward pickup (nullable).
391
+ * forward pickup (nullable), having 24hour time format HH:MM.
386
392
  * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
387
- * reverse pickup (nullable).
393
+ * reverse pickup (nullable), having 24hour time format HH:MM.
394
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
388
395
  * @property {CourierPartnerSchemeDefaultTat} [default_tat]
389
396
  * @property {ArithmeticOperations} weight
390
397
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -417,7 +424,7 @@ const Joi = require("joi");
417
424
  * @property {string} [created_on] - The timestamp when the record was created.
418
425
  * @property {string} [modified_on] - The timestamp when the record last modified.
419
426
  * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
420
- * @property {string} [company_id] - Unique identifier of company.
427
+ * @property {string} [company_id] - The unique identifier of the company.
421
428
  * @property {string} name - Name of the scheme.
422
429
  * @property {ArithmeticOperations} weight
423
430
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -440,6 +447,12 @@ const Joi = require("joi");
440
447
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
441
448
  * quantity of items allowed in a non-quality check shipment.
442
449
  * @property {CourierPartnerSchemeFeatures} feature
450
+ * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
451
+ * forward pickup (nullable), having 24hour time format HH:MM.
452
+ * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
453
+ * reverse pickup (nullable), having 24hour time format HH:MM.
454
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
455
+ * @property {CourierPartnerSchemeDefaultTat} [default_tat]
443
456
  */
444
457
 
445
458
  /**
@@ -472,6 +485,12 @@ const Joi = require("joi");
472
485
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
473
486
  * quantity of items allowed in a non-quality check shipment.
474
487
  * @property {CourierPartnerSchemeFeatures} feature
488
+ * @property {string} [default_forward_pickup_cutoff] - Default cutoff time for
489
+ * forward pickup (nullable), having 24hour time format HH:MM.
490
+ * @property {string} [default_reverse_pickup_cutoff] - Default cutoff time for
491
+ * reverse pickup (nullable), having 24hour time format HH:MM.
492
+ * @property {string} [default_cutoff_timezone] - Timezone for default cutoff time.
493
+ * @property {CourierPartnerSchemeDefaultTat} [default_tat]
475
494
  */
476
495
 
477
496
  /**
@@ -568,6 +587,20 @@ const Joi = require("joi");
568
587
  * quantity of items allowed in a non-quality check shipment.
569
588
  */
570
589
 
590
+ /**
591
+ * @typedef CourierPartnerSchemeDefaultTat
592
+ * @property {boolean} [enabled] - Indicates whether the default turn around
593
+ * time (tat) to be used for the given scheme or not.
594
+ * @property {CourierPartnerSchemeTat} [tat]
595
+ */
596
+
597
+ /**
598
+ * @typedef CourierPartnerSchemeTat
599
+ * @property {number} [min] - Minimum turn around time (tat) value for a scheme.
600
+ * @property {number} [max] - Maximum turn around time (tat) value for a scheme.
601
+ * @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
602
+ */
603
+
571
604
  /**
572
605
  * @typedef Error
573
606
  * @property {string} [type] - The type of the error.
@@ -613,20 +646,6 @@ const Joi = require("joi");
613
646
  * @property {CourierPartnerSchemeFeatures} feature
614
647
  */
615
648
 
616
- /**
617
- * @typedef CourierPartnerSchemeDefaultTat
618
- * @property {boolean} [enabled] - Indicates whether the default turn around
619
- * time (tat) to be used for the given scheme or not.
620
- * @property {CourierPartnerSchemeTat} [tat]
621
- */
622
-
623
- /**
624
- * @typedef CourierPartnerSchemeTat
625
- * @property {number} [min] - Minimum turn around time (tat) value for a scheme.
626
- * @property {number} [max] - Maximum turn around time (tat) value for a scheme.
627
- * @property {string} [unit] - Unit for the turn around time (tat) values for a scheme.
628
- */
629
-
630
649
  /**
631
650
  * @typedef GetCountriesItems
632
651
  * @property {string} [id] - A string serving as the unique identifier.
@@ -698,6 +717,10 @@ class LogisticsPartnerModel {
698
717
  qc_shipment_item_quantity: Joi.number().allow(null),
699
718
  non_qc_shipment_item_quantity: Joi.number().allow(null),
700
719
  feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
720
+ default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
721
+ default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
722
+ default_cutoff_timezone: Joi.string().allow("").allow(null),
723
+ default_tat: LogisticsPartnerModel.CourierPartnerSchemeDefaultTat(),
701
724
  });
702
725
  }
703
726
 
@@ -990,6 +1013,7 @@ class LogisticsPartnerModel {
990
1013
  name: Joi.string().allow("").required(),
991
1014
  default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
992
1015
  default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
1016
+ default_cutoff_timezone: Joi.string().allow("").allow(null),
993
1017
  default_tat: LogisticsPartnerModel.CourierPartnerSchemeDefaultTat(),
994
1018
  weight: LogisticsPartnerModel.ArithmeticOperations().required(),
995
1019
  volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
@@ -1029,6 +1053,10 @@ class LogisticsPartnerModel {
1029
1053
  qc_shipment_item_quantity: Joi.number().allow(null),
1030
1054
  non_qc_shipment_item_quantity: Joi.number().allow(null),
1031
1055
  feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
1056
+ default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
1057
+ default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
1058
+ default_cutoff_timezone: Joi.string().allow("").allow(null),
1059
+ default_tat: LogisticsPartnerModel.CourierPartnerSchemeDefaultTat(),
1032
1060
  });
1033
1061
  }
1034
1062
 
@@ -1058,6 +1086,10 @@ class LogisticsPartnerModel {
1058
1086
  qc_shipment_item_quantity: Joi.number().allow(null),
1059
1087
  non_qc_shipment_item_quantity: Joi.number().allow(null),
1060
1088
  feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
1089
+ default_forward_pickup_cutoff: Joi.string().allow("").allow(null),
1090
+ default_reverse_pickup_cutoff: Joi.string().allow("").allow(null),
1091
+ default_cutoff_timezone: Joi.string().allow("").allow(null),
1092
+ default_tat: LogisticsPartnerModel.CourierPartnerSchemeDefaultTat(),
1061
1093
  });
1062
1094
  }
1063
1095
 
@@ -1147,6 +1179,23 @@ class LogisticsPartnerModel {
1147
1179
  });
1148
1180
  }
1149
1181
 
1182
+ /** @returns {CourierPartnerSchemeDefaultTat} */
1183
+ static CourierPartnerSchemeDefaultTat() {
1184
+ return Joi.object({
1185
+ enabled: Joi.boolean(),
1186
+ tat: LogisticsPartnerModel.CourierPartnerSchemeTat(),
1187
+ });
1188
+ }
1189
+
1190
+ /** @returns {CourierPartnerSchemeTat} */
1191
+ static CourierPartnerSchemeTat() {
1192
+ return Joi.object({
1193
+ min: Joi.number(),
1194
+ max: Joi.number(),
1195
+ unit: Joi.string().allow(""),
1196
+ });
1197
+ }
1198
+
1150
1199
  /** @returns {Error} */
1151
1200
  static Error() {
1152
1201
  return Joi.object({
@@ -1195,23 +1244,6 @@ class LogisticsPartnerModel {
1195
1244
  });
1196
1245
  }
1197
1246
 
1198
- /** @returns {CourierPartnerSchemeDefaultTat} */
1199
- static CourierPartnerSchemeDefaultTat() {
1200
- return Joi.object({
1201
- enabled: Joi.boolean(),
1202
- tat: LogisticsPartnerModel.CourierPartnerSchemeTat(),
1203
- });
1204
- }
1205
-
1206
- /** @returns {CourierPartnerSchemeTat} */
1207
- static CourierPartnerSchemeTat() {
1208
- return Joi.object({
1209
- min: Joi.number(),
1210
- max: Joi.number(),
1211
- unit: Joi.string().allow(""),
1212
- });
1213
- }
1214
-
1215
1247
  /** @returns {GetCountriesItems} */
1216
1248
  static GetCountriesItems() {
1217
1249
  return Joi.object({
@@ -307,6 +307,7 @@ export = WebhookPartnerModel;
307
307
  * @property {string} [name] - The name of the item.
308
308
  * @property {string} [webhook_url] - The URL of the webhook associated with the item.
309
309
  * @property {string} [provider] - The provider of the item.
310
+ * @property {string} [source] - Source that subscriber belongs to.
310
311
  * @property {Association} [association]
311
312
  * @property {Object} [custom_headers] - Custom headers associated with the item, if any.
312
313
  * @property {string} [status] - The current status of the item.
@@ -1062,6 +1063,10 @@ type ItemSchema = {
1062
1063
  * - The provider of the item.
1063
1064
  */
1064
1065
  provider?: string;
1066
+ /**
1067
+ * - Source that subscriber belongs to.
1068
+ */
1069
+ source?: string;
1065
1070
  association?: Association;
1066
1071
  /**
1067
1072
  * - Custom headers associated with the item, if any.
@@ -341,6 +341,7 @@ const Joi = require("joi");
341
341
  * @property {string} [name] - The name of the item.
342
342
  * @property {string} [webhook_url] - The URL of the webhook associated with the item.
343
343
  * @property {string} [provider] - The provider of the item.
344
+ * @property {string} [source] - Source that subscriber belongs to.
344
345
  * @property {Association} [association]
345
346
  * @property {Object} [custom_headers] - Custom headers associated with the item, if any.
346
347
  * @property {string} [status] - The current status of the item.
@@ -703,6 +704,7 @@ class WebhookPartnerModel {
703
704
  name: Joi.string().allow(""),
704
705
  webhook_url: Joi.string().allow(""),
705
706
  provider: Joi.string().allow(""),
707
+ source: Joi.string().allow("").allow(null),
706
708
  association: WebhookPartnerModel.Association(),
707
709
  custom_headers: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
708
710
  status: Joi.string().allow(""),