@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,22 @@ class Webhook {
28
28
  return Promise.reject(new FDKClientValidationError(error));
29
29
  }
30
30
 
31
+ // Showing warrnings if extra unknown parameters are found
32
+ const {
33
+ error: warrning,
34
+ } = WebhookValidator.getSubscribersByCompany().validate(
35
+ {
36
+ pageNo,
37
+ pageSize,
38
+ extensionId,
39
+ },
40
+ { abortEarly: false, allowUnknown: false }
41
+ );
42
+ if (warrning) {
43
+ console.log("Parameter Validation warrnings for getSubscribersByCompany");
44
+ console.log(warrning);
45
+ }
46
+
31
47
  const query_params = {};
32
48
  query_params["page_no"] = pageNo;
33
49
  query_params["page_size"] = pageSize;
@@ -62,6 +78,22 @@ class Webhook {
62
78
  return Promise.reject(new FDKClientValidationError(error));
63
79
  }
64
80
 
81
+ // Showing warrnings if extra unknown parameters are found
82
+ const {
83
+ error: warrning,
84
+ } = WebhookValidator.registerSubscriberToEvent().validate(
85
+ {
86
+ body,
87
+ },
88
+ { abortEarly: false, allowUnknown: false }
89
+ );
90
+ if (warrning) {
91
+ console.log(
92
+ "Parameter Validation warrnings for registerSubscriberToEvent"
93
+ );
94
+ console.log(warrning);
95
+ }
96
+
65
97
  const query_params = {};
66
98
 
67
99
  const xHeaders = {};
@@ -93,6 +125,20 @@ class Webhook {
93
125
  return Promise.reject(new FDKClientValidationError(error));
94
126
  }
95
127
 
128
+ // Showing warrnings if extra unknown parameters are found
129
+ const {
130
+ error: warrning,
131
+ } = WebhookValidator.updateSubscriberConfig().validate(
132
+ {
133
+ body,
134
+ },
135
+ { abortEarly: false, allowUnknown: false }
136
+ );
137
+ if (warrning) {
138
+ console.log("Parameter Validation warrnings for updateSubscriberConfig");
139
+ console.log(warrning);
140
+ }
141
+
96
142
  const query_params = {};
97
143
 
98
144
  const xHeaders = {};
@@ -128,6 +174,24 @@ class Webhook {
128
174
  return Promise.reject(new FDKClientValidationError(error));
129
175
  }
130
176
 
177
+ // Showing warrnings if extra unknown parameters are found
178
+ const {
179
+ error: warrning,
180
+ } = WebhookValidator.getSubscribersByExtensionId().validate(
181
+ {
182
+ extensionId,
183
+ pageNo,
184
+ pageSize,
185
+ },
186
+ { abortEarly: false, allowUnknown: false }
187
+ );
188
+ if (warrning) {
189
+ console.log(
190
+ "Parameter Validation warrnings for getSubscribersByExtensionId"
191
+ );
192
+ console.log(warrning);
193
+ }
194
+
131
195
  const query_params = {};
132
196
  query_params["page_no"] = pageNo;
133
197
  query_params["page_size"] = pageSize;
@@ -161,6 +225,18 @@ class Webhook {
161
225
  return Promise.reject(new FDKClientValidationError(error));
162
226
  }
163
227
 
228
+ // Showing warrnings if extra unknown parameters are found
229
+ const { error: warrning } = WebhookValidator.getSubscriberById().validate(
230
+ {
231
+ subscriberId,
232
+ },
233
+ { abortEarly: false, allowUnknown: false }
234
+ );
235
+ if (warrning) {
236
+ console.log("Parameter Validation warrnings for getSubscriberById");
237
+ console.log(warrning);
238
+ }
239
+
164
240
  const query_params = {};
165
241
 
166
242
  const xHeaders = {};
@@ -189,6 +265,20 @@ class Webhook {
189
265
  return Promise.reject(new FDKClientValidationError(error));
190
266
  }
191
267
 
268
+ // Showing warrnings if extra unknown parameters are found
269
+ const {
270
+ error: warrning,
271
+ } = WebhookValidator.fetchAllEventConfigurations().validate(
272
+ {},
273
+ { abortEarly: false, allowUnknown: false }
274
+ );
275
+ if (warrning) {
276
+ console.log(
277
+ "Parameter Validation warrnings for fetchAllEventConfigurations"
278
+ );
279
+ console.log(warrning);
280
+ }
281
+
192
282
  const query_params = {};
193
283
 
194
284
  const xHeaders = {};
@@ -1,6 +1,7 @@
1
1
  const PublicAPIClient = require("../PublicAPIClient");
2
2
  const { FDKClientValidationError } = require("../../common/FDKError");
3
3
  const constructUrl = require("../constructUrl");
4
+ const Paginator = require("../../common/Paginator");
4
5
  const ConfigurationValidator = require("./ConfigurationPublicValidator");
5
6
  class Configuration {
6
7
  constructor(_conf) {
@@ -42,6 +43,19 @@ class Configuration {
42
43
  if (error) {
43
44
  return Promise.reject(new FDKClientValidationError(error));
44
45
  }
46
+
47
+ // Showing warrnings if extra unknown parameters are found
48
+ const {
49
+ error: warrning,
50
+ } = ConfigurationValidator.searchApplication().validate(
51
+ { authorization, query },
52
+ { abortEarly: false, allowUnknown: false }
53
+ );
54
+ if (warrning) {
55
+ console.log("Parameter Validation warrnings for searchApplication");
56
+ console.log(warrning);
57
+ }
58
+
45
59
  const query_params = {};
46
60
  query_params["query"] = query;
47
61
 
@@ -80,6 +94,17 @@ class Configuration {
80
94
  if (error) {
81
95
  return Promise.reject(new FDKClientValidationError(error));
82
96
  }
97
+
98
+ // Showing warrnings if extra unknown parameters are found
99
+ const { error: warrning } = ConfigurationValidator.getLocations().validate(
100
+ { locationType, id },
101
+ { abortEarly: false, allowUnknown: false }
102
+ );
103
+ if (warrning) {
104
+ console.log("Parameter Validation warrnings for getLocations");
105
+ console.log(warrning);
106
+ }
107
+
83
108
  const query_params = {};
84
109
  query_params["location_type"] = locationType;
85
110
  query_params["id"] = id;
@@ -1,5 +1,6 @@
1
- const ConfigurationModel = require("./ConfigurationPublicModel");
2
1
  const Joi = require("joi");
2
+
3
+ const ConfigurationModel = require("./ConfigurationPublicModel");
3
4
  class ConfigurationValidator {
4
5
  static searchApplication() {
5
6
  return Joi.object({
@@ -15,4 +16,5 @@ class ConfigurationValidator {
15
16
  });
16
17
  }
17
18
  }
19
+
18
20
  module.exports = ConfigurationValidator;
@@ -1,6 +1,7 @@
1
1
  const PublicAPIClient = require("../PublicAPIClient");
2
2
  const { FDKClientValidationError } = require("../../common/FDKError");
3
3
  const constructUrl = require("../constructUrl");
4
+ const Paginator = require("../../common/Paginator");
4
5
  const InventoryValidator = require("./InventoryPublicValidator");
5
6
  class Inventory {
6
7
  constructor(_conf) {
@@ -48,6 +49,19 @@ class Inventory {
48
49
  if (error) {
49
50
  return Promise.reject(new FDKClientValidationError(error));
50
51
  }
52
+
53
+ // Showing warrnings if extra unknown parameters are found
54
+ const {
55
+ error: warrning,
56
+ } = InventoryValidator.getJobCodesMetrics().validate(
57
+ { dailyJob, jobCode },
58
+ { abortEarly: false, allowUnknown: false }
59
+ );
60
+ if (warrning) {
61
+ console.log("Parameter Validation warrnings for getJobCodesMetrics");
62
+ console.log(warrning);
63
+ }
64
+
51
65
  const query_params = {};
52
66
  query_params["daily_job"] = dailyJob;
53
67
  query_params["job_code"] = jobCode;
@@ -82,6 +96,19 @@ class Inventory {
82
96
  if (error) {
83
97
  return Promise.reject(new FDKClientValidationError(error));
84
98
  }
99
+
100
+ // Showing warrnings if extra unknown parameters are found
101
+ const {
102
+ error: warrning,
103
+ } = InventoryValidator.saveJobCodesMetrics().validate(
104
+ { body },
105
+ { abortEarly: false, allowUnknown: false }
106
+ );
107
+ if (warrning) {
108
+ console.log("Parameter Validation warrnings for saveJobCodesMetrics");
109
+ console.log(warrning);
110
+ }
111
+
85
112
  const query_params = {};
86
113
 
87
114
  const xHeaders = {};
@@ -114,6 +141,17 @@ class Inventory {
114
141
  if (error) {
115
142
  return Promise.reject(new FDKClientValidationError(error));
116
143
  }
144
+
145
+ // Showing warrnings if extra unknown parameters are found
146
+ const { error: warrning } = InventoryValidator.getConfigByApiKey().validate(
147
+ { apikey },
148
+ { abortEarly: false, allowUnknown: false }
149
+ );
150
+ if (warrning) {
151
+ console.log("Parameter Validation warrnings for getConfigByApiKey");
152
+ console.log(warrning);
153
+ }
154
+
117
155
  const query_params = {};
118
156
  query_params["apikey"] = apikey;
119
157
 
@@ -148,6 +186,17 @@ class Inventory {
148
186
  if (error) {
149
187
  return Promise.reject(new FDKClientValidationError(error));
150
188
  }
189
+
190
+ // Showing warrnings if extra unknown parameters are found
191
+ const { error: warrning } = InventoryValidator.getApiKey().validate(
192
+ { userName, password },
193
+ { abortEarly: false, allowUnknown: false }
194
+ );
195
+ if (warrning) {
196
+ console.log("Parameter Validation warrnings for getApiKey");
197
+ console.log(warrning);
198
+ }
199
+
151
200
  const query_params = {};
152
201
  query_params["user_name"] = userName;
153
202
  query_params["password"] = password;
@@ -182,6 +231,17 @@ class Inventory {
182
231
  if (error) {
183
232
  return Promise.reject(new FDKClientValidationError(error));
184
233
  }
234
+
235
+ // Showing warrnings if extra unknown parameters are found
236
+ const { error: warrning } = InventoryValidator.getJobByCode().validate(
237
+ { code },
238
+ { abortEarly: false, allowUnknown: false }
239
+ );
240
+ if (warrning) {
241
+ console.log("Parameter Validation warrnings for getJobByCode");
242
+ console.log(warrning);
243
+ }
244
+
185
245
  const query_params = {};
186
246
 
187
247
  const xHeaders = {};
@@ -217,6 +277,21 @@ class Inventory {
217
277
  if (error) {
218
278
  return Promise.reject(new FDKClientValidationError(error));
219
279
  }
280
+
281
+ // Showing warrnings if extra unknown parameters are found
282
+ const {
283
+ error: warrning,
284
+ } = InventoryValidator.getJobConfigByIntegrationType().validate(
285
+ { integrationType, disable },
286
+ { abortEarly: false, allowUnknown: false }
287
+ );
288
+ if (warrning) {
289
+ console.log(
290
+ "Parameter Validation warrnings for getJobConfigByIntegrationType"
291
+ );
292
+ console.log(warrning);
293
+ }
294
+
220
295
  const query_params = {};
221
296
  query_params["integration_type"] = integrationType;
222
297
  query_params["disable"] = disable;
@@ -1,5 +1,6 @@
1
- const InventoryModel = require("./InventoryPublicModel");
2
1
  const Joi = require("joi");
2
+
3
+ const InventoryModel = require("./InventoryPublicModel");
3
4
  class InventoryValidator {
4
5
  static getJobCodesMetrics() {
5
6
  return Joi.object({
@@ -40,4 +41,5 @@ class InventoryValidator {
40
41
  }).required();
41
42
  }
42
43
  }
44
+
43
45
  module.exports = InventoryValidator;
@@ -1,6 +1,7 @@
1
1
  const PublicAPIClient = require("../PublicAPIClient");
2
2
  const { FDKClientValidationError } = require("../../common/FDKError");
3
3
  const constructUrl = require("../constructUrl");
4
+ const Paginator = require("../../common/Paginator");
4
5
  const WebhookValidator = require("./WebhookPublicValidator");
5
6
  class Webhook {
6
7
  constructor(_conf) {
@@ -40,6 +41,19 @@ class Webhook {
40
41
  if (error) {
41
42
  return Promise.reject(new FDKClientValidationError(error));
42
43
  }
44
+
45
+ // Showing warrnings if extra unknown parameters are found
46
+ const {
47
+ error: warrning,
48
+ } = WebhookValidator.fetchAllWebhookEvents().validate(
49
+ {},
50
+ { abortEarly: false, allowUnknown: false }
51
+ );
52
+ if (warrning) {
53
+ console.log("Parameter Validation warrnings for fetchAllWebhookEvents");
54
+ console.log(warrning);
55
+ }
56
+
43
57
  const query_params = {};
44
58
 
45
59
  const xHeaders = {};
@@ -72,6 +86,21 @@ class Webhook {
72
86
  if (error) {
73
87
  return Promise.reject(new FDKClientValidationError(error));
74
88
  }
89
+
90
+ // Showing warrnings if extra unknown parameters are found
91
+ const {
92
+ error: warrning,
93
+ } = WebhookValidator.queryWebhookEventDetails().validate(
94
+ { body },
95
+ { abortEarly: false, allowUnknown: false }
96
+ );
97
+ if (warrning) {
98
+ console.log(
99
+ "Parameter Validation warrnings for queryWebhookEventDetails"
100
+ );
101
+ console.log(warrning);
102
+ }
103
+
75
104
  const query_params = {};
76
105
 
77
106
  const xHeaders = {};
@@ -1,5 +1,6 @@
1
- const WebhookModel = require("./WebhookPublicModel");
2
1
  const Joi = require("joi");
2
+
3
+ const WebhookModel = require("./WebhookPublicModel");
3
4
  class WebhookValidator {
4
5
  static fetchAllWebhookEvents() {
5
6
  return Joi.object({});
@@ -11,4 +12,5 @@ class WebhookValidator {
11
12
  }).required();
12
13
  }
13
14
  }
15
+
14
16
  module.exports = WebhookValidator;