@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

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 (156) hide show
  1. package/documentation/application/CART.md +251 -251
  2. package/documentation/application/CATALOG.md +393 -393
  3. package/documentation/application/CONTENT.md +15 -1
  4. package/documentation/application/ORDER.md +268 -268
  5. package/documentation/application/PAYMENT.md +249 -249
  6. package/documentation/application/POSCART.md +297 -297
  7. package/documentation/platform/CART.md +499 -499
  8. package/documentation/platform/CATALOG.md +3497 -3097
  9. package/documentation/platform/COMPANYPROFILE.md +207 -207
  10. package/documentation/platform/CONTENT.md +123 -1
  11. package/documentation/platform/ORDER.md +1518 -1324
  12. package/documentation/platform/PARTNER.md +7 -7
  13. package/documentation/platform/PAYMENT.md +96 -96
  14. package/index.js +7 -1
  15. package/package.json +1 -1
  16. package/sdk/application/ApplicationConfig.js +1 -1
  17. package/sdk/application/Cart/CartApplicationClient.js +865 -52
  18. package/sdk/application/Cart/CartApplicationModel.d.ts +7 -7
  19. package/sdk/application/Cart/CartApplicationModel.js +335 -335
  20. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  21. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
  22. package/sdk/application/Catalog/CatalogApplicationClient.js +1034 -60
  23. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +19 -19
  24. package/sdk/application/Catalog/CatalogApplicationModel.js +532 -532
  25. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  26. package/sdk/application/Common/CommonApplicationClient.js +66 -4
  27. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  28. package/sdk/application/Communication/CommunicationApplicationClient.js +108 -6
  29. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  30. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +1 -1
  31. package/sdk/application/Configuration/ConfigurationApplicationClient.js +558 -32
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  33. package/sdk/application/Content/ContentApplicationClient.js +621 -38
  34. package/sdk/application/Content/ContentApplicationModel.d.ts +1 -0
  35. package/sdk/application/Content/ContentApplicationModel.js +11 -1
  36. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  37. package/sdk/application/FileStorage/FileStorageApplicationClient.js +101 -6
  38. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  39. package/sdk/application/Lead/LeadApplicationClient.js +229 -14
  40. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  41. package/sdk/application/Logistic/LogisticApplicationClient.js +134 -8
  42. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  44. package/sdk/application/Order/OrderApplicationClient.js +403 -24
  45. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  46. package/sdk/application/Order/OrderApplicationModel.js +334 -334
  47. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  48. package/sdk/application/Payment/PaymentApplicationClient.js +1381 -78
  49. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2 -2
  50. package/sdk/application/Payment/PaymentApplicationModel.js +350 -350
  51. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  52. package/sdk/application/PosCart/PosCartApplicationClient.js +914 -54
  53. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +15 -15
  54. package/sdk/application/PosCart/PosCartApplicationModel.js +389 -389
  55. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  56. package/sdk/application/Rewards/RewardsApplicationClient.js +235 -14
  57. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  58. package/sdk/application/Share/ShareApplicationClient.js +226 -14
  59. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  60. package/sdk/application/Theme/ThemeApplicationClient.js +130 -8
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  62. package/sdk/application/User/UserApplicationClient.js +1133 -70
  63. package/sdk/application/User/UserApplicationValidator.js +1 -0
  64. package/sdk/common/AxiosHelper.js +1 -1
  65. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +16 -8
  66. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +287 -16
  67. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  68. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +153 -8
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +141 -8
  71. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -12
  72. package/sdk/platform/Billing/BillingPlatformClient.js +429 -24
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -17
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +617 -34
  75. package/sdk/platform/Cart/CartPlatformModel.d.ts +35 -35
  76. package/sdk/platform/Cart/CartPlatformModel.js +617 -617
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +191 -138
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2202 -302
  79. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +11 -11
  80. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +45 -45
  81. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +344 -226
  82. package/sdk/platform/Catalog/CatalogPlatformClient.js +3282 -488
  83. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +110 -100
  84. package/sdk/platform/Catalog/CatalogPlatformModel.js +2073 -1795
  85. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +23 -21
  86. package/sdk/platform/Catalog/CatalogPlatformValidator.js +103 -84
  87. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -2
  88. package/sdk/platform/Common/CommonPlatformClient.js +73 -4
  89. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -40
  90. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1499 -80
  91. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  92. package/sdk/platform/Communication/CommunicationPlatformClient.js +41 -2
  93. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -14
  94. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +486 -26
  95. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +9 -9
  96. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +274 -274
  97. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +56 -28
  98. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1022 -56
  99. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  100. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +693 -36
  101. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +148 -67
  102. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2446 -140
  103. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -0
  104. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -0
  105. package/sdk/platform/Content/ContentPlatformModel.d.ts +4 -0
  106. package/sdk/platform/Content/ContentPlatformModel.js +43 -1
  107. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +21 -10
  108. package/sdk/platform/Discount/DiscountPlatformClient.js +400 -22
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +8 -4
  110. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +148 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +214 -12
  113. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +27 -14
  114. package/sdk/platform/Inventory/InventoryPlatformClient.js +449 -24
  115. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +26 -13
  116. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +447 -26
  117. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -11
  118. package/sdk/platform/Lead/LeadPlatformClient.js +384 -22
  119. package/sdk/platform/OAuthClient.js +8 -8
  120. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -3
  121. package/sdk/platform/Order/OrderPlatformApplicationClient.js +125 -6
  122. package/sdk/platform/Order/OrderPlatformClient.d.ts +108 -47
  123. package/sdk/platform/Order/OrderPlatformClient.js +1641 -100
  124. package/sdk/platform/Order/OrderPlatformModel.d.ts +69 -58
  125. package/sdk/platform/Order/OrderPlatformModel.js +1485 -1493
  126. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  127. package/sdk/platform/Order/OrderPlatformValidator.js +15 -4
  128. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  129. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +74 -4
  130. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  131. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  132. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -11
  133. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +418 -22
  134. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +21 -11
  135. package/sdk/platform/Payment/PaymentPlatformClient.js +374 -20
  136. package/sdk/platform/Payment/PaymentPlatformModel.js +139 -139
  137. package/sdk/platform/PlatformApplicationClient.d.ts +2973 -2827
  138. package/sdk/platform/PlatformApplicationClient.js +3461 -3263
  139. package/sdk/platform/PlatformClient.d.ts +2973 -2827
  140. package/sdk/platform/PlatformClient.js +3461 -3263
  141. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +26 -13
  142. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +449 -26
  143. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +8 -4
  144. package/sdk/platform/Share/SharePlatformApplicationClient.js +139 -8
  145. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +47 -23
  146. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +816 -48
  147. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +24 -12
  148. package/sdk/platform/User/UserPlatformApplicationClient.js +417 -24
  149. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +12 -6
  150. package/sdk/platform/Webhook/WebhookPlatformClient.js +229 -12
  151. package/sdk/public/Configuration/ConfigurationPublicClient.js +72 -4
  152. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  153. package/sdk/public/Inventory/InventoryPublicClient.js +210 -12
  154. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  155. package/sdk/public/Webhook/WebhookPublicClient.js +74 -4
  156. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -3,6 +3,8 @@ const constructUrl = require("../constructUrl");
3
3
  const Paginator = require("../../common/Paginator");
4
4
  const { FDKClientValidationError } = require("../../common/FDKError");
5
5
  const LogisticValidator = require("./LogisticApplicationValidator");
6
+ const LogisticModel = require("./LogisticApplicationModel");
7
+ const { Logger } = require("./../../common/Logger");
6
8
 
7
9
  class Logistic {
8
10
  constructor(_conf) {
@@ -38,7 +40,7 @@ class Logistic {
38
40
  * @summary: Get Pincode API
39
41
  * @description: Get pincode data
40
42
  */
41
- getPincodeCity({ pincode, countryCode } = {}) {
43
+ async getPincodeCity({ pincode, countryCode } = {}) {
42
44
  const { error } = LogisticValidator.getPincodeCity().validate(
43
45
  { pincode, countryCode },
44
46
  { abortEarly: false, allowUnknown: true }
@@ -46,12 +48,26 @@ class Logistic {
46
48
  if (error) {
47
49
  return Promise.reject(new FDKClientValidationError(error));
48
50
  }
51
+
52
+ // Showing warrnings if extra unknown parameters are found
53
+ const { error: warrning } = LogisticValidator.getPincodeCity().validate(
54
+ { pincode, countryCode },
55
+ { abortEarly: false, allowUnknown: false }
56
+ );
57
+ if (warrning) {
58
+ Logger({
59
+ level: "WARN",
60
+ message: "Parameter Validation warrnings for getPincodeCity",
61
+ });
62
+ Logger({ level: "WARN", message: warrning });
63
+ }
64
+
49
65
  const query_params = {};
50
66
  query_params["country_code"] = countryCode;
51
67
 
52
68
  const xHeaders = {};
53
69
 
54
- return APIClient.execute(
70
+ const response = await APIClient.execute(
55
71
  this._conf,
56
72
  "get",
57
73
  constructUrl({
@@ -62,6 +78,23 @@ class Logistic {
62
78
  undefined,
63
79
  xHeaders
64
80
  );
81
+
82
+ const {
83
+ error: res_error,
84
+ } = LogisticModel.PincodeApiResponse().validate(response, {
85
+ abortEarly: false,
86
+ allowUnknown: false,
87
+ });
88
+
89
+ if (res_error) {
90
+ Logger({
91
+ level: "WARN",
92
+ message: "Response Validation Warnnings for getPincodeCity",
93
+ });
94
+ Logger({ level: "WARN", message: res_error });
95
+ }
96
+
97
+ return response;
65
98
  }
66
99
 
67
100
  /**
@@ -71,7 +104,7 @@ class Logistic {
71
104
  * @summary: Get TAT API
72
105
  * @description: Get TAT data
73
106
  */
74
- getTatProduct({ body } = {}) {
107
+ async getTatProduct({ body } = {}) {
75
108
  const { error } = LogisticValidator.getTatProduct().validate(
76
109
  { body },
77
110
  { abortEarly: false, allowUnknown: true }
@@ -79,11 +112,25 @@ class Logistic {
79
112
  if (error) {
80
113
  return Promise.reject(new FDKClientValidationError(error));
81
114
  }
115
+
116
+ // Showing warrnings if extra unknown parameters are found
117
+ const { error: warrning } = LogisticValidator.getTatProduct().validate(
118
+ { body },
119
+ { abortEarly: false, allowUnknown: false }
120
+ );
121
+ if (warrning) {
122
+ Logger({
123
+ level: "WARN",
124
+ message: "Parameter Validation warrnings for getTatProduct",
125
+ });
126
+ Logger({ level: "WARN", message: warrning });
127
+ }
128
+
82
129
  const query_params = {};
83
130
 
84
131
  const xHeaders = {};
85
132
 
86
- return APIClient.execute(
133
+ const response = await APIClient.execute(
87
134
  this._conf,
88
135
  "post",
89
136
  constructUrl({
@@ -94,6 +141,23 @@ class Logistic {
94
141
  body,
95
142
  xHeaders
96
143
  );
144
+
145
+ const {
146
+ error: res_error,
147
+ } = LogisticModel.TATViewResponse().validate(response, {
148
+ abortEarly: false,
149
+ allowUnknown: false,
150
+ });
151
+
152
+ if (res_error) {
153
+ Logger({
154
+ level: "WARN",
155
+ message: "Response Validation Warnnings for getTatProduct",
156
+ });
157
+ Logger({ level: "WARN", message: res_error });
158
+ }
159
+
160
+ return response;
97
161
  }
98
162
 
99
163
  /**
@@ -102,7 +166,7 @@ class Logistic {
102
166
  * @summary: Get Country List
103
167
  * @description: Get all countries
104
168
  */
105
- getAllCountries({} = {}) {
169
+ async getAllCountries({} = {}) {
106
170
  const { error } = LogisticValidator.getAllCountries().validate(
107
171
  {},
108
172
  { abortEarly: false, allowUnknown: true }
@@ -110,11 +174,25 @@ class Logistic {
110
174
  if (error) {
111
175
  return Promise.reject(new FDKClientValidationError(error));
112
176
  }
177
+
178
+ // Showing warrnings if extra unknown parameters are found
179
+ const { error: warrning } = LogisticValidator.getAllCountries().validate(
180
+ {},
181
+ { abortEarly: false, allowUnknown: false }
182
+ );
183
+ if (warrning) {
184
+ Logger({
185
+ level: "WARN",
186
+ message: "Parameter Validation warrnings for getAllCountries",
187
+ });
188
+ Logger({ level: "WARN", message: warrning });
189
+ }
190
+
113
191
  const query_params = {};
114
192
 
115
193
  const xHeaders = {};
116
194
 
117
- return APIClient.execute(
195
+ const response = await APIClient.execute(
118
196
  this._conf,
119
197
  "get",
120
198
  constructUrl({
@@ -125,6 +203,23 @@ class Logistic {
125
203
  undefined,
126
204
  xHeaders
127
205
  );
206
+
207
+ const {
208
+ error: res_error,
209
+ } = LogisticModel.CountryListResponse().validate(response, {
210
+ abortEarly: false,
211
+ allowUnknown: false,
212
+ });
213
+
214
+ if (res_error) {
215
+ Logger({
216
+ level: "WARN",
217
+ message: "Response Validation Warnnings for getAllCountries",
218
+ });
219
+ Logger({ level: "WARN", message: res_error });
220
+ }
221
+
222
+ return response;
128
223
  }
129
224
 
130
225
  /**
@@ -134,7 +229,7 @@ class Logistic {
134
229
  * @summary: GET zone from the Pincode.
135
230
  * @description: This API returns zone from the Pincode View.
136
231
  */
137
- getPincodeZones({ body } = {}) {
232
+ async getPincodeZones({ body } = {}) {
138
233
  const { error } = LogisticValidator.getPincodeZones().validate(
139
234
  { body },
140
235
  { abortEarly: false, allowUnknown: true }
@@ -142,11 +237,25 @@ class Logistic {
142
237
  if (error) {
143
238
  return Promise.reject(new FDKClientValidationError(error));
144
239
  }
240
+
241
+ // Showing warrnings if extra unknown parameters are found
242
+ const { error: warrning } = LogisticValidator.getPincodeZones().validate(
243
+ { body },
244
+ { abortEarly: false, allowUnknown: false }
245
+ );
246
+ if (warrning) {
247
+ Logger({
248
+ level: "WARN",
249
+ message: "Parameter Validation warrnings for getPincodeZones",
250
+ });
251
+ Logger({ level: "WARN", message: warrning });
252
+ }
253
+
145
254
  const query_params = {};
146
255
 
147
256
  const xHeaders = {};
148
257
 
149
- return APIClient.execute(
258
+ const response = await APIClient.execute(
150
259
  this._conf,
151
260
  "post",
152
261
  constructUrl({
@@ -157,6 +266,23 @@ class Logistic {
157
266
  body,
158
267
  xHeaders
159
268
  );
269
+
270
+ const {
271
+ error: res_error,
272
+ } = LogisticModel.GetZoneFromPincodeViewResponse().validate(response, {
273
+ abortEarly: false,
274
+ allowUnknown: false,
275
+ });
276
+
277
+ if (res_error) {
278
+ Logger({
279
+ level: "WARN",
280
+ message: "Response Validation Warnnings for getPincodeZones",
281
+ });
282
+ Logger({ level: "WARN", message: res_error });
283
+ }
284
+
285
+ return response;
160
286
  }
161
287
  }
162
288
 
@@ -25,4 +25,5 @@ class LogisticValidator {
25
25
  }).required();
26
26
  }
27
27
  }
28
+
28
29
  module.exports = LogisticValidator;
@@ -35,7 +35,7 @@ declare class Order {
35
35
  * @summary: Get all orders
36
36
  * @description: Use this API to retrieve all the orders.
37
37
  */
38
- getOrders({ status, pageNo, pageSize, fromDate, toDate, customMeta }?: {
38
+ getOrders({ status, pageNo, pageSize, fromDate, toDate, customMeta, }?: {
39
39
  status?: number;
40
40
  pageNo?: number;
41
41
  pageSize?: number;