@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
@@ -28,6 +28,19 @@ class Rewards {
28
28
  return Promise.reject(new FDKClientValidationError(error));
29
29
  }
30
30
 
31
+ // Showing warrnings if extra unknown parameters are found
32
+ const { error: warrning } = RewardsValidator.showGiveaways().validate(
33
+ {
34
+ pageId,
35
+ pageSize,
36
+ },
37
+ { abortEarly: false, allowUnknown: false }
38
+ );
39
+ if (warrning) {
40
+ console.log("Parameter Validation warrnings for showGiveaways");
41
+ console.log(warrning);
42
+ }
43
+
31
44
  const query_params = {};
32
45
  query_params["page_id"] = pageId;
33
46
  query_params["page_size"] = pageSize;
@@ -58,6 +71,18 @@ class Rewards {
58
71
  return Promise.reject(new FDKClientValidationError(error));
59
72
  }
60
73
 
74
+ // Showing warrnings if extra unknown parameters are found
75
+ const { error: warrning } = RewardsValidator.saveGiveAway().validate(
76
+ {
77
+ body,
78
+ },
79
+ { abortEarly: false, allowUnknown: false }
80
+ );
81
+ if (warrning) {
82
+ console.log("Parameter Validation warrnings for saveGiveAway");
83
+ console.log(warrning);
84
+ }
85
+
61
86
  const query_params = {};
62
87
 
63
88
  return PlatformAPIClient.execute(
@@ -86,6 +111,18 @@ class Rewards {
86
111
  return Promise.reject(new FDKClientValidationError(error));
87
112
  }
88
113
 
114
+ // Showing warrnings if extra unknown parameters are found
115
+ const { error: warrning } = RewardsValidator.getGiveawayById().validate(
116
+ {
117
+ id,
118
+ },
119
+ { abortEarly: false, allowUnknown: false }
120
+ );
121
+ if (warrning) {
122
+ console.log("Parameter Validation warrnings for getGiveawayById");
123
+ console.log(warrning);
124
+ }
125
+
89
126
  const query_params = {};
90
127
 
91
128
  return PlatformAPIClient.execute(
@@ -116,6 +153,19 @@ class Rewards {
116
153
  return Promise.reject(new FDKClientValidationError(error));
117
154
  }
118
155
 
156
+ // Showing warrnings if extra unknown parameters are found
157
+ const { error: warrning } = RewardsValidator.updateGiveAway().validate(
158
+ {
159
+ id,
160
+ body,
161
+ },
162
+ { abortEarly: false, allowUnknown: false }
163
+ );
164
+ if (warrning) {
165
+ console.log("Parameter Validation warrnings for updateGiveAway");
166
+ console.log(warrning);
167
+ }
168
+
119
169
  const query_params = {};
120
170
 
121
171
  return PlatformAPIClient.execute(
@@ -144,6 +194,22 @@ class Rewards {
144
194
  return Promise.reject(new FDKClientValidationError(error));
145
195
  }
146
196
 
197
+ // Showing warrnings if extra unknown parameters are found
198
+ const {
199
+ error: warrning,
200
+ } = RewardsValidator.getGiveawayAudienceStatus().validate(
201
+ {
202
+ audienceId,
203
+ },
204
+ { abortEarly: false, allowUnknown: false }
205
+ );
206
+ if (warrning) {
207
+ console.log(
208
+ "Parameter Validation warrnings for getGiveawayAudienceStatus"
209
+ );
210
+ console.log(warrning);
211
+ }
212
+
147
213
  const query_params = {};
148
214
 
149
215
  return PlatformAPIClient.execute(
@@ -169,6 +235,16 @@ class Rewards {
169
235
  return Promise.reject(new FDKClientValidationError(error));
170
236
  }
171
237
 
238
+ // Showing warrnings if extra unknown parameters are found
239
+ const { error: warrning } = RewardsValidator.showOffers().validate(
240
+ {},
241
+ { abortEarly: false, allowUnknown: false }
242
+ );
243
+ if (warrning) {
244
+ console.log("Parameter Validation warrnings for showOffers");
245
+ console.log(warrning);
246
+ }
247
+
172
248
  const query_params = {};
173
249
 
174
250
  return PlatformAPIClient.execute(
@@ -201,6 +277,19 @@ class Rewards {
201
277
  return Promise.reject(new FDKClientValidationError(error));
202
278
  }
203
279
 
280
+ // Showing warrnings if extra unknown parameters are found
281
+ const { error: warrning } = RewardsValidator.getOfferByName().validate(
282
+ {
283
+ name,
284
+ cookie,
285
+ },
286
+ { abortEarly: false, allowUnknown: false }
287
+ );
288
+ if (warrning) {
289
+ console.log("Parameter Validation warrnings for getOfferByName");
290
+ console.log(warrning);
291
+ }
292
+
204
293
  const query_params = {};
205
294
 
206
295
  return PlatformAPIClient.execute(
@@ -231,6 +320,19 @@ class Rewards {
231
320
  return Promise.reject(new FDKClientValidationError(error));
232
321
  }
233
322
 
323
+ // Showing warrnings if extra unknown parameters are found
324
+ const { error: warrning } = RewardsValidator.updateOfferByName().validate(
325
+ {
326
+ name,
327
+ body,
328
+ },
329
+ { abortEarly: false, allowUnknown: false }
330
+ );
331
+ if (warrning) {
332
+ console.log("Parameter Validation warrnings for updateOfferByName");
333
+ console.log(warrning);
334
+ }
335
+
234
336
  const query_params = {};
235
337
 
236
338
  return PlatformAPIClient.execute(
@@ -261,6 +363,19 @@ class Rewards {
261
363
  return Promise.reject(new FDKClientValidationError(error));
262
364
  }
263
365
 
366
+ // Showing warrnings if extra unknown parameters are found
367
+ const { error: warrning } = RewardsValidator.updateUserStatus().validate(
368
+ {
369
+ userId,
370
+ body,
371
+ },
372
+ { abortEarly: false, allowUnknown: false }
373
+ );
374
+ if (warrning) {
375
+ console.log("Parameter Validation warrnings for updateUserStatus");
376
+ console.log(warrning);
377
+ }
378
+
264
379
  const query_params = {};
265
380
 
266
381
  return PlatformAPIClient.execute(
@@ -289,6 +404,18 @@ class Rewards {
289
404
  return Promise.reject(new FDKClientValidationError(error));
290
405
  }
291
406
 
407
+ // Showing warrnings if extra unknown parameters are found
408
+ const { error: warrning } = RewardsValidator.user().validate(
409
+ {
410
+ userId,
411
+ },
412
+ { abortEarly: false, allowUnknown: false }
413
+ );
414
+ if (warrning) {
415
+ console.log("Parameter Validation warrnings for user");
416
+ console.log(warrning);
417
+ }
418
+
292
419
  const query_params = {};
293
420
 
294
421
  return PlatformAPIClient.execute(
@@ -322,6 +449,22 @@ class Rewards {
322
449
  return Promise.reject(new FDKClientValidationError(error));
323
450
  }
324
451
 
452
+ // Showing warrnings if extra unknown parameters are found
453
+ const {
454
+ error: warrning,
455
+ } = RewardsValidator.getUserPointsHistory().validate(
456
+ {
457
+ userId,
458
+ pageId,
459
+ pageSize,
460
+ },
461
+ { abortEarly: false, allowUnknown: false }
462
+ );
463
+ if (warrning) {
464
+ console.log("Parameter Validation warrnings for getUserPointsHistory");
465
+ console.log(warrning);
466
+ }
467
+
325
468
  const query_params = {};
326
469
  query_params["page_id"] = pageId;
327
470
  query_params["page_size"] = pageSize;
@@ -386,6 +529,18 @@ class Rewards {
386
529
  return Promise.reject(new FDKClientValidationError(error));
387
530
  }
388
531
 
532
+ // Showing warrnings if extra unknown parameters are found
533
+ const {
534
+ error: warrning,
535
+ } = RewardsValidator.getRewardsConfiguration().validate(
536
+ {},
537
+ { abortEarly: false, allowUnknown: false }
538
+ );
539
+ if (warrning) {
540
+ console.log("Parameter Validation warrnings for getRewardsConfiguration");
541
+ console.log(warrning);
542
+ }
543
+
389
544
  const query_params = {};
390
545
 
391
546
  return PlatformAPIClient.execute(
@@ -414,6 +569,20 @@ class Rewards {
414
569
  return Promise.reject(new FDKClientValidationError(error));
415
570
  }
416
571
 
572
+ // Showing warrnings if extra unknown parameters are found
573
+ const {
574
+ error: warrning,
575
+ } = RewardsValidator.setRewardsConfiguration().validate(
576
+ {
577
+ body,
578
+ },
579
+ { abortEarly: false, allowUnknown: false }
580
+ );
581
+ if (warrning) {
582
+ console.log("Parameter Validation warrnings for setRewardsConfiguration");
583
+ console.log(warrning);
584
+ }
585
+
417
586
  const query_params = {};
418
587
 
419
588
  return PlatformAPIClient.execute(
@@ -26,6 +26,18 @@ class Share {
26
26
  return Promise.reject(new FDKClientValidationError(error));
27
27
  }
28
28
 
29
+ // Showing warrnings if extra unknown parameters are found
30
+ const { error: warrning } = ShareValidator.createShortLink().validate(
31
+ {
32
+ body,
33
+ },
34
+ { abortEarly: false, allowUnknown: false }
35
+ );
36
+ if (warrning) {
37
+ console.log("Parameter Validation warrnings for createShortLink");
38
+ console.log(warrning);
39
+ }
40
+
29
41
  const query_params = {};
30
42
 
31
43
  return PlatformAPIClient.execute(
@@ -62,6 +74,22 @@ class Share {
62
74
  return Promise.reject(new FDKClientValidationError(error));
63
75
  }
64
76
 
77
+ // Showing warrnings if extra unknown parameters are found
78
+ const { error: warrning } = ShareValidator.getShortLinks().validate(
79
+ {
80
+ pageNo,
81
+ pageSize,
82
+ createdBy,
83
+ active,
84
+ q,
85
+ },
86
+ { abortEarly: false, allowUnknown: false }
87
+ );
88
+ if (warrning) {
89
+ console.log("Parameter Validation warrnings for getShortLinks");
90
+ console.log(warrning);
91
+ }
92
+
65
93
  const query_params = {};
66
94
  query_params["page_no"] = pageNo;
67
95
  query_params["page_size"] = pageSize;
@@ -138,6 +166,18 @@ class Share {
138
166
  return Promise.reject(new FDKClientValidationError(error));
139
167
  }
140
168
 
169
+ // Showing warrnings if extra unknown parameters are found
170
+ const { error: warrning } = ShareValidator.getShortLinkByHash().validate(
171
+ {
172
+ hash,
173
+ },
174
+ { abortEarly: false, allowUnknown: false }
175
+ );
176
+ if (warrning) {
177
+ console.log("Parameter Validation warrnings for getShortLinkByHash");
178
+ console.log(warrning);
179
+ }
180
+
141
181
  const query_params = {};
142
182
 
143
183
  return PlatformAPIClient.execute(
@@ -168,6 +208,19 @@ class Share {
168
208
  return Promise.reject(new FDKClientValidationError(error));
169
209
  }
170
210
 
211
+ // Showing warrnings if extra unknown parameters are found
212
+ const { error: warrning } = ShareValidator.updateShortLinkById().validate(
213
+ {
214
+ id,
215
+ body,
216
+ },
217
+ { abortEarly: false, allowUnknown: false }
218
+ );
219
+ if (warrning) {
220
+ console.log("Parameter Validation warrnings for updateShortLinkById");
221
+ console.log(warrning);
222
+ }
223
+
171
224
  const query_params = {};
172
225
 
173
226
  return PlatformAPIClient.execute(