@gofynd/fdk-client-javascript 1.0.0 → 1.0.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 (104) hide show
  1. package/documentation/application/CATALOG.md +371 -371
  2. package/documentation/application/ORDER.md +272 -272
  3. package/documentation/application/PAYMENT.md +269 -269
  4. package/documentation/platform/CATALOG.md +1678 -1664
  5. package/documentation/platform/COMPANYPROFILE.md +201 -201
  6. package/documentation/platform/ORDER.md +1442 -1323
  7. package/documentation/platform/PAYMENT.md +88 -88
  8. package/index.js +7 -1
  9. package/package.json +1 -1
  10. package/sdk/application/Cart/CartApplicationClient.js +302 -0
  11. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +378 -0
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +17 -17
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +500 -500
  15. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  16. package/sdk/application/Common/CommonApplicationClient.js +22 -0
  17. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  18. package/sdk/application/Communication/CommunicationApplicationClient.js +41 -0
  19. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  20. package/sdk/application/Configuration/ConfigurationApplicationClient.js +200 -0
  21. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  22. package/sdk/application/Content/ContentApplicationClient.js +215 -0
  23. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  24. package/sdk/application/FileStorage/FileStorageApplicationClient.js +33 -0
  25. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  26. package/sdk/application/Lead/LeadApplicationClient.js +81 -0
  27. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  28. package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
  29. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  30. package/sdk/application/Order/OrderApplicationClient.js +146 -0
  31. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  32. package/sdk/application/Order/OrderApplicationModel.js +329 -329
  33. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  34. package/sdk/application/Payment/PaymentApplicationClient.js +528 -0
  35. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -5
  36. package/sdk/application/Payment/PaymentApplicationModel.js +391 -391
  37. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  38. package/sdk/application/PosCart/PosCartApplicationClient.js +329 -0
  39. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  40. package/sdk/application/Rewards/RewardsApplicationClient.js +81 -0
  41. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  42. package/sdk/application/Share/ShareApplicationClient.js +87 -0
  43. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  44. package/sdk/application/Theme/ThemeApplicationClient.js +44 -0
  45. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  46. package/sdk/application/User/UserApplicationClient.js +405 -0
  47. package/sdk/application/User/UserApplicationValidator.js +1 -0
  48. package/sdk/common/AxiosHelper.js +1 -1
  49. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +114 -0
  50. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +58 -0
  51. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +46 -0
  52. package/sdk/platform/Billing/BillingPlatformClient.js +160 -0
  53. package/sdk/platform/Cart/CartPlatformApplicationClient.js +246 -0
  54. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +29 -29
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +839 -48
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +3 -3
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +9 -9
  58. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +54 -54
  59. package/sdk/platform/Catalog/CatalogPlatformClient.js +1149 -96
  60. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +58 -57
  61. package/sdk/platform/Catalog/CatalogPlatformModel.js +1626 -1614
  62. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +6 -6
  63. package/sdk/platform/Catalog/CatalogPlatformValidator.js +20 -20
  64. package/sdk/platform/Common/CommonPlatformClient.js +26 -0
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +587 -0
  66. package/sdk/platform/Communication/CommunicationPlatformClient.js +15 -0
  67. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +179 -0
  68. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +11 -11
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +269 -269
  70. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +382 -0
  71. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +282 -0
  72. package/sdk/platform/Content/ContentPlatformApplicationClient.js +866 -0
  73. package/sdk/platform/Discount/DiscountPlatformClient.js +152 -0
  74. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +54 -0
  75. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +76 -0
  76. package/sdk/platform/Inventory/InventoryPlatformClient.js +161 -0
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +162 -0
  78. package/sdk/platform/Lead/LeadPlatformClient.js +140 -0
  79. package/sdk/platform/Order/OrderPlatformApplicationClient.js +55 -0
  80. package/sdk/platform/Order/OrderPlatformClient.d.ts +15 -6
  81. package/sdk/platform/Order/OrderPlatformClient.js +674 -15
  82. package/sdk/platform/Order/OrderPlatformModel.d.ts +67 -60
  83. package/sdk/platform/Order/OrderPlatformModel.js +1559 -1623
  84. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  85. package/sdk/platform/Order/OrderPlatformValidator.js +10 -4
  86. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +26 -0
  87. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +165 -0
  88. package/sdk/platform/Payment/PaymentPlatformClient.js +139 -0
  89. package/sdk/platform/Payment/PaymentPlatformModel.js +137 -137
  90. package/sdk/platform/PlatformApplicationClient.d.ts +2217 -2243
  91. package/sdk/platform/PlatformApplicationClient.js +2514 -2524
  92. package/sdk/platform/PlatformClient.d.ts +2217 -2243
  93. package/sdk/platform/PlatformClient.js +2514 -2524
  94. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +169 -0
  95. package/sdk/platform/Share/SharePlatformApplicationClient.js +53 -0
  96. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +293 -0
  97. package/sdk/platform/User/UserPlatformApplicationClient.js +145 -0
  98. package/sdk/platform/Webhook/WebhookPlatformClient.js +90 -0
  99. package/sdk/public/Configuration/ConfigurationPublicClient.js +25 -0
  100. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  101. package/sdk/public/Inventory/InventoryPublicClient.js +75 -0
  102. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  103. package/sdk/public/Webhook/WebhookPublicClient.js +29 -0
  104. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -72,6 +72,17 @@ class Order {
72
72
  if (error) {
73
73
  return Promise.reject(new FDKClientValidationError(error));
74
74
  }
75
+
76
+ // Showing warrnings if extra unknown parameters are found
77
+ const { error: warrning } = OrderValidator.getOrders().validate(
78
+ { status, pageNo, pageSize, fromDate, toDate, customMeta },
79
+ { abortEarly: false, allowUnknown: false }
80
+ );
81
+ if (warrning) {
82
+ console.log("Parameter Validation warrnings for getOrders");
83
+ console.log(warrning);
84
+ }
85
+
75
86
  const query_params = {};
76
87
  query_params["status"] = status;
77
88
  query_params["page_no"] = pageNo;
@@ -111,6 +122,17 @@ class Order {
111
122
  if (error) {
112
123
  return Promise.reject(new FDKClientValidationError(error));
113
124
  }
125
+
126
+ // Showing warrnings if extra unknown parameters are found
127
+ const { error: warrning } = OrderValidator.getOrderById().validate(
128
+ { orderId },
129
+ { abortEarly: false, allowUnknown: false }
130
+ );
131
+ if (warrning) {
132
+ console.log("Parameter Validation warrnings for getOrderById");
133
+ console.log(warrning);
134
+ }
135
+
114
136
  const query_params = {};
115
137
 
116
138
  const xHeaders = {};
@@ -144,6 +166,17 @@ class Order {
144
166
  if (error) {
145
167
  return Promise.reject(new FDKClientValidationError(error));
146
168
  }
169
+
170
+ // Showing warrnings if extra unknown parameters are found
171
+ const { error: warrning } = OrderValidator.getPosOrderById().validate(
172
+ { orderId },
173
+ { abortEarly: false, allowUnknown: false }
174
+ );
175
+ if (warrning) {
176
+ console.log("Parameter Validation warrnings for getPosOrderById");
177
+ console.log(warrning);
178
+ }
179
+
147
180
  const query_params = {};
148
181
 
149
182
  const xHeaders = {};
@@ -178,6 +211,17 @@ class Order {
178
211
  if (error) {
179
212
  return Promise.reject(new FDKClientValidationError(error));
180
213
  }
214
+
215
+ // Showing warrnings if extra unknown parameters are found
216
+ const { error: warrning } = OrderValidator.getShipmentById().validate(
217
+ { shipmentId },
218
+ { abortEarly: false, allowUnknown: false }
219
+ );
220
+ if (warrning) {
221
+ console.log("Parameter Validation warrnings for getShipmentById");
222
+ console.log(warrning);
223
+ }
224
+
181
225
  const query_params = {};
182
226
 
183
227
  const xHeaders = {};
@@ -210,6 +254,19 @@ class Order {
210
254
  if (error) {
211
255
  return Promise.reject(new FDKClientValidationError(error));
212
256
  }
257
+
258
+ // Showing warrnings if extra unknown parameters are found
259
+ const {
260
+ error: warrning,
261
+ } = OrderValidator.getInvoiceByShipmentId().validate(
262
+ { shipmentId },
263
+ { abortEarly: false, allowUnknown: false }
264
+ );
265
+ if (warrning) {
266
+ console.log("Parameter Validation warrnings for getInvoiceByShipmentId");
267
+ console.log(warrning);
268
+ }
269
+
213
270
  const query_params = {};
214
271
 
215
272
  const xHeaders = {};
@@ -244,6 +301,17 @@ class Order {
244
301
  if (error) {
245
302
  return Promise.reject(new FDKClientValidationError(error));
246
303
  }
304
+
305
+ // Showing warrnings if extra unknown parameters are found
306
+ const { error: warrning } = OrderValidator.trackShipment().validate(
307
+ { shipmentId },
308
+ { abortEarly: false, allowUnknown: false }
309
+ );
310
+ if (warrning) {
311
+ console.log("Parameter Validation warrnings for trackShipment");
312
+ console.log(warrning);
313
+ }
314
+
247
315
  const query_params = {};
248
316
 
249
317
  const xHeaders = {};
@@ -280,6 +348,21 @@ class Order {
280
348
  if (error) {
281
349
  return Promise.reject(new FDKClientValidationError(error));
282
350
  }
351
+
352
+ // Showing warrnings if extra unknown parameters are found
353
+ const {
354
+ error: warrning,
355
+ } = OrderValidator.getCustomerDetailsByShipmentId().validate(
356
+ { orderId, shipmentId },
357
+ { abortEarly: false, allowUnknown: false }
358
+ );
359
+ if (warrning) {
360
+ console.log(
361
+ "Parameter Validation warrnings for getCustomerDetailsByShipmentId"
362
+ );
363
+ console.log(warrning);
364
+ }
365
+
283
366
  const query_params = {};
284
367
 
285
368
  const xHeaders = {};
@@ -316,6 +399,21 @@ class Order {
316
399
  if (error) {
317
400
  return Promise.reject(new FDKClientValidationError(error));
318
401
  }
402
+
403
+ // Showing warrnings if extra unknown parameters are found
404
+ const {
405
+ error: warrning,
406
+ } = OrderValidator.sendOtpToShipmentCustomer().validate(
407
+ { orderId, shipmentId },
408
+ { abortEarly: false, allowUnknown: false }
409
+ );
410
+ if (warrning) {
411
+ console.log(
412
+ "Parameter Validation warrnings for sendOtpToShipmentCustomer"
413
+ );
414
+ console.log(warrning);
415
+ }
416
+
319
417
  const query_params = {};
320
418
 
321
419
  const xHeaders = {};
@@ -353,6 +451,21 @@ class Order {
353
451
  if (error) {
354
452
  return Promise.reject(new FDKClientValidationError(error));
355
453
  }
454
+
455
+ // Showing warrnings if extra unknown parameters are found
456
+ const {
457
+ error: warrning,
458
+ } = OrderValidator.verifyOtpShipmentCustomer().validate(
459
+ { orderId, shipmentId, body },
460
+ { abortEarly: false, allowUnknown: false }
461
+ );
462
+ if (warrning) {
463
+ console.log(
464
+ "Parameter Validation warrnings for verifyOtpShipmentCustomer"
465
+ );
466
+ console.log(warrning);
467
+ }
468
+
356
469
  const query_params = {};
357
470
 
358
471
  const xHeaders = {};
@@ -389,6 +502,17 @@ class Order {
389
502
  if (error) {
390
503
  return Promise.reject(new FDKClientValidationError(error));
391
504
  }
505
+
506
+ // Showing warrnings if extra unknown parameters are found
507
+ const { error: warrning } = OrderValidator.getShipmentBagReasons().validate(
508
+ { shipmentId, bagId },
509
+ { abortEarly: false, allowUnknown: false }
510
+ );
511
+ if (warrning) {
512
+ console.log("Parameter Validation warrnings for getShipmentBagReasons");
513
+ console.log(warrning);
514
+ }
515
+
392
516
  const query_params = {};
393
517
 
394
518
  const xHeaders = {};
@@ -423,6 +547,17 @@ class Order {
423
547
  if (error) {
424
548
  return Promise.reject(new FDKClientValidationError(error));
425
549
  }
550
+
551
+ // Showing warrnings if extra unknown parameters are found
552
+ const { error: warrning } = OrderValidator.getShipmentReasons().validate(
553
+ { shipmentId },
554
+ { abortEarly: false, allowUnknown: false }
555
+ );
556
+ if (warrning) {
557
+ console.log("Parameter Validation warrnings for getShipmentReasons");
558
+ console.log(warrning);
559
+ }
560
+
426
561
  const query_params = {};
427
562
 
428
563
  const xHeaders = {};
@@ -458,6 +593,17 @@ class Order {
458
593
  if (error) {
459
594
  return Promise.reject(new FDKClientValidationError(error));
460
595
  }
596
+
597
+ // Showing warrnings if extra unknown parameters are found
598
+ const { error: warrning } = OrderValidator.updateShipmentStatus().validate(
599
+ { shipmentId, body },
600
+ { abortEarly: false, allowUnknown: false }
601
+ );
602
+ if (warrning) {
603
+ console.log("Parameter Validation warrnings for updateShipmentStatus");
604
+ console.log(warrning);
605
+ }
606
+
461
607
  const query_params = {};
462
608
 
463
609
  const xHeaders = {};
@@ -2,34 +2,34 @@ export = OrderModel;
2
2
  declare class OrderModel {
3
3
  static OrderStatuses(): any;
4
4
  static OrderFilters(): any;
5
- static BreakupValues(): any;
6
- static UserInfo(): any;
5
+ static OrderPage(): any;
7
6
  static BagsForReorderArticleAssignment(): any;
8
7
  static BagsForReorder(): any;
8
+ static UserInfo(): any;
9
+ static NestedTrackingDetails(): any;
10
+ static TrackingDetails(): any;
11
+ static FulfillingCompany(): any;
9
12
  static TimeStampData(): any;
10
13
  static Promise(): any;
11
- static ShipmentUserInfo(): any;
12
- static ShipmentTotalDetails(): any;
13
- static ShipmentPayment(): any;
14
- static ShipmentStatus(): any;
15
- static DeliveryAddress(): any;
16
- static FulfillingCompany(): any;
14
+ static Prices(): any;
17
15
  static CurrentStatus(): any;
18
16
  static ItemBrand(): any;
19
17
  static Item(): any;
20
- static Prices(): any;
21
18
  static AppliedFreeArticles(): any;
22
19
  static AppliedPromos(): any;
23
20
  static Identifiers(): any;
24
21
  static FinancialBreakup(): any;
25
22
  static Bags(): any;
23
+ static ShipmentUserInfo(): any;
26
24
  static FulfillingStore(): any;
25
+ static BreakupValues(): any;
27
26
  static Invoice(): any;
28
- static NestedTrackingDetails(): any;
29
- static TrackingDetails(): any;
27
+ static DeliveryAddress(): any;
28
+ static ShipmentStatus(): any;
29
+ static ShipmentPayment(): any;
30
+ static ShipmentTotalDetails(): any;
30
31
  static Shipments(): any;
31
32
  static OrderSchema(): any;
32
- static OrderPage(): any;
33
33
  static OrderList(): any;
34
34
  static ApefaceApiError(): any;
35
35
  static OrderById(): any;
@@ -41,23 +41,23 @@ declare class OrderModel {
41
41
  static SendOtpToCustomerResponse(): any;
42
42
  static VerifyOtp(): any;
43
43
  static VerifyOtpResponse(): any;
44
- static QuestionSet(): any;
45
44
  static BagReasonMeta(): any;
45
+ static QuestionSet(): any;
46
46
  static BagReasons(): any;
47
47
  static ShipmentBagReasons(): any;
48
48
  static ShipmentReason(): any;
49
49
  static ShipmentReasons(): any;
50
- static EntityReasonData(): any;
51
- static EntitiesReasons(): any;
52
- static ProductsReasonsFilters(): any;
53
- static ProductsReasonsData(): any;
54
- static ProductsReasons(): any;
55
- static ReasonsData(): any;
56
- static EntitiesDataUpdates(): any;
57
50
  static ProductsDataUpdatesFilters(): any;
58
51
  static ProductsDataUpdates(): any;
52
+ static EntitiesDataUpdates(): any;
59
53
  static DataUpdates(): any;
60
54
  static Products(): any;
55
+ static ProductsReasonsFilters(): any;
56
+ static ProductsReasonsData(): any;
57
+ static ProductsReasons(): any;
58
+ static EntityReasonData(): any;
59
+ static EntitiesReasons(): any;
60
+ static ReasonsData(): any;
61
61
  static ShipmentsRequest(): any;
62
62
  static StatuesRequest(): any;
63
63
  static UpdateShipmentStatusRequest(): any;