@gofynd/fdk-client-javascript 3.16.3 → 3.17.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +40 -0
- package/sdk/application/Cart/CartApplicationClient.js +176 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +18 -4
- package/sdk/application/Catalog/CatalogApplicationClient.js +47 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +21 -1
- package/sdk/application/Content/ContentApplicationClient.js +93 -2
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -21
- package/sdk/application/Logistic/LogisticApplicationClient.js +34 -83
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
- package/sdk/application/Order/OrderApplicationClient.js +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +5 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +74 -12
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +637 -36
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +225 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +147 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +952 -5
- package/sdk/platform/Cart/CartPlatformModel.js +598 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +125 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +831 -41
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +205 -7
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +154 -3
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +5 -16
- package/sdk/platform/Catalog/CatalogPlatformClient.js +8 -85
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1025 -159
- package/sdk/platform/Catalog/CatalogPlatformModel.js +840 -165
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +8 -10
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +3 -12
- package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
- package/sdk/platform/Common/CommonPlatformModel.js +14 -0
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -462
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +7 -45
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +4 -55
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +10 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +92 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +54 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +21 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +9 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +27 -19
- package/sdk/platform/Order/OrderPlatformClient.js +176 -108
- package/sdk/platform/Order/OrderPlatformModel.d.ts +359 -45
- package/sdk/platform/Order/OrderPlatformModel.js +218 -44
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
- package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +14 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +88 -6
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +28 -3
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +22 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +376 -11
- package/sdk/platform/Payment/PaymentPlatformModel.js +243 -10
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +29 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +13 -0
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
- package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +29 -0
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -410
|
@@ -96,231 +96,6 @@ class Communication {
|
|
|
96
96
|
return response;
|
|
97
97
|
}
|
|
98
98
|
|
|
99
|
-
/**
|
|
100
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryHeadersParam} arg
|
|
101
|
-
* - Arg object
|
|
102
|
-
*
|
|
103
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
104
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
105
|
-
* @returns {Promise<Object>} - Success response
|
|
106
|
-
* @name createBigQueryHeaders
|
|
107
|
-
* @summary: Create BigQuery headers
|
|
108
|
-
* @description: Create BigQuery headers - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryHeaders/).
|
|
109
|
-
*/
|
|
110
|
-
async createBigQueryHeaders(
|
|
111
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
112
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
113
|
-
) {
|
|
114
|
-
const {
|
|
115
|
-
error,
|
|
116
|
-
} = CommunicationPlatformApplicationValidator.createBigQueryHeaders().validate(
|
|
117
|
-
{},
|
|
118
|
-
{ abortEarly: false, allowUnknown: true }
|
|
119
|
-
);
|
|
120
|
-
if (error) {
|
|
121
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
122
|
-
}
|
|
123
|
-
|
|
124
|
-
// Showing warrnings if extra unknown parameters are found
|
|
125
|
-
const {
|
|
126
|
-
error: warrning,
|
|
127
|
-
} = CommunicationPlatformApplicationValidator.createBigQueryHeaders().validate(
|
|
128
|
-
{},
|
|
129
|
-
{ abortEarly: false, allowUnknown: false }
|
|
130
|
-
);
|
|
131
|
-
if (warrning) {
|
|
132
|
-
Logger({
|
|
133
|
-
level: "WARN",
|
|
134
|
-
message: `Parameter Validation warrnings for platform > Communication > createBigQueryHeaders \n ${warrning}`,
|
|
135
|
-
});
|
|
136
|
-
}
|
|
137
|
-
|
|
138
|
-
const query_params = {};
|
|
139
|
-
|
|
140
|
-
const response = await PlatformAPIClient.execute(
|
|
141
|
-
this.config,
|
|
142
|
-
"post",
|
|
143
|
-
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-headers`,
|
|
144
|
-
query_params,
|
|
145
|
-
undefined,
|
|
146
|
-
requestHeaders,
|
|
147
|
-
{ responseHeaders }
|
|
148
|
-
);
|
|
149
|
-
|
|
150
|
-
let responseData = response;
|
|
151
|
-
if (responseHeaders) {
|
|
152
|
-
responseData = response[0];
|
|
153
|
-
}
|
|
154
|
-
|
|
155
|
-
const { error: res_error } = Joi.any().validate(responseData, {
|
|
156
|
-
abortEarly: false,
|
|
157
|
-
allowUnknown: true,
|
|
158
|
-
});
|
|
159
|
-
|
|
160
|
-
if (res_error) {
|
|
161
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
162
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
163
|
-
} else {
|
|
164
|
-
Logger({
|
|
165
|
-
level: "WARN",
|
|
166
|
-
message: `Response Validation Warnings for platform > Communication > createBigQueryHeaders \n ${res_error}`,
|
|
167
|
-
});
|
|
168
|
-
}
|
|
169
|
-
}
|
|
170
|
-
|
|
171
|
-
return response;
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
/**
|
|
175
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryNCountParam} arg
|
|
176
|
-
* - Arg object
|
|
177
|
-
*
|
|
178
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<Object>} - Success response
|
|
181
|
-
* @name createBigQueryNCount
|
|
182
|
-
* @summary: Create BigQuery N-count
|
|
183
|
-
* @description: Creates big query n count - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryNCount/).
|
|
184
|
-
*/
|
|
185
|
-
async createBigQueryNCount(
|
|
186
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
187
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
188
|
-
) {
|
|
189
|
-
const {
|
|
190
|
-
error,
|
|
191
|
-
} = CommunicationPlatformApplicationValidator.createBigQueryNCount().validate(
|
|
192
|
-
{},
|
|
193
|
-
{ abortEarly: false, allowUnknown: true }
|
|
194
|
-
);
|
|
195
|
-
if (error) {
|
|
196
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
// Showing warrnings if extra unknown parameters are found
|
|
200
|
-
const {
|
|
201
|
-
error: warrning,
|
|
202
|
-
} = CommunicationPlatformApplicationValidator.createBigQueryNCount().validate(
|
|
203
|
-
{},
|
|
204
|
-
{ abortEarly: false, allowUnknown: false }
|
|
205
|
-
);
|
|
206
|
-
if (warrning) {
|
|
207
|
-
Logger({
|
|
208
|
-
level: "WARN",
|
|
209
|
-
message: `Parameter Validation warrnings for platform > Communication > createBigQueryNCount \n ${warrning}`,
|
|
210
|
-
});
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
const query_params = {};
|
|
214
|
-
|
|
215
|
-
const response = await PlatformAPIClient.execute(
|
|
216
|
-
this.config,
|
|
217
|
-
"post",
|
|
218
|
-
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-n-records`,
|
|
219
|
-
query_params,
|
|
220
|
-
undefined,
|
|
221
|
-
requestHeaders,
|
|
222
|
-
{ responseHeaders }
|
|
223
|
-
);
|
|
224
|
-
|
|
225
|
-
let responseData = response;
|
|
226
|
-
if (responseHeaders) {
|
|
227
|
-
responseData = response[0];
|
|
228
|
-
}
|
|
229
|
-
|
|
230
|
-
const { error: res_error } = Joi.any().validate(responseData, {
|
|
231
|
-
abortEarly: false,
|
|
232
|
-
allowUnknown: true,
|
|
233
|
-
});
|
|
234
|
-
|
|
235
|
-
if (res_error) {
|
|
236
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
237
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
238
|
-
} else {
|
|
239
|
-
Logger({
|
|
240
|
-
level: "WARN",
|
|
241
|
-
message: `Response Validation Warnings for platform > Communication > createBigQueryNCount \n ${res_error}`,
|
|
242
|
-
});
|
|
243
|
-
}
|
|
244
|
-
}
|
|
245
|
-
|
|
246
|
-
return response;
|
|
247
|
-
}
|
|
248
|
-
|
|
249
|
-
/**
|
|
250
|
-
* @param {CommunicationPlatformApplicationValidator.CreateBigQueryRowCountParam} arg
|
|
251
|
-
* - Arg object
|
|
252
|
-
*
|
|
253
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
254
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
255
|
-
* @returns {Promise<Object>} - Success response
|
|
256
|
-
* @name createBigQueryRowCount
|
|
257
|
-
* @summary: Create a BigQuery row count
|
|
258
|
-
* @description: Creates big query row count - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/createBigQueryRowCount/).
|
|
259
|
-
*/
|
|
260
|
-
async createBigQueryRowCount(
|
|
261
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
262
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
263
|
-
) {
|
|
264
|
-
const {
|
|
265
|
-
error,
|
|
266
|
-
} = CommunicationPlatformApplicationValidator.createBigQueryRowCount().validate(
|
|
267
|
-
{},
|
|
268
|
-
{ abortEarly: false, allowUnknown: true }
|
|
269
|
-
);
|
|
270
|
-
if (error) {
|
|
271
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
// Showing warrnings if extra unknown parameters are found
|
|
275
|
-
const {
|
|
276
|
-
error: warrning,
|
|
277
|
-
} = CommunicationPlatformApplicationValidator.createBigQueryRowCount().validate(
|
|
278
|
-
{},
|
|
279
|
-
{ abortEarly: false, allowUnknown: false }
|
|
280
|
-
);
|
|
281
|
-
if (warrning) {
|
|
282
|
-
Logger({
|
|
283
|
-
level: "WARN",
|
|
284
|
-
message: `Parameter Validation warrnings for platform > Communication > createBigQueryRowCount \n ${warrning}`,
|
|
285
|
-
});
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
const query_params = {};
|
|
289
|
-
|
|
290
|
-
const response = await PlatformAPIClient.execute(
|
|
291
|
-
this.config,
|
|
292
|
-
"post",
|
|
293
|
-
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-row-count`,
|
|
294
|
-
query_params,
|
|
295
|
-
undefined,
|
|
296
|
-
requestHeaders,
|
|
297
|
-
{ responseHeaders }
|
|
298
|
-
);
|
|
299
|
-
|
|
300
|
-
let responseData = response;
|
|
301
|
-
if (responseHeaders) {
|
|
302
|
-
responseData = response[0];
|
|
303
|
-
}
|
|
304
|
-
|
|
305
|
-
const { error: res_error } = Joi.any().validate(responseData, {
|
|
306
|
-
abortEarly: false,
|
|
307
|
-
allowUnknown: true,
|
|
308
|
-
});
|
|
309
|
-
|
|
310
|
-
if (res_error) {
|
|
311
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
312
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
313
|
-
} else {
|
|
314
|
-
Logger({
|
|
315
|
-
level: "WARN",
|
|
316
|
-
message: `Response Validation Warnings for platform > Communication > createBigQueryRowCount \n ${res_error}`,
|
|
317
|
-
});
|
|
318
|
-
}
|
|
319
|
-
}
|
|
320
|
-
|
|
321
|
-
return response;
|
|
322
|
-
}
|
|
323
|
-
|
|
324
99
|
/**
|
|
325
100
|
* @param {CommunicationPlatformApplicationValidator.CreateCampaignParam} arg
|
|
326
101
|
* - Arg object
|
|
@@ -1790,164 +1565,6 @@ class Communication {
|
|
|
1790
1565
|
return response;
|
|
1791
1566
|
}
|
|
1792
1567
|
|
|
1793
|
-
/**
|
|
1794
|
-
* @param {CommunicationPlatformApplicationValidator.GetBigQueryHeadersByIdParam} arg
|
|
1795
|
-
* - Arg object
|
|
1796
|
-
*
|
|
1797
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1798
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1799
|
-
* @returns {Promise<Object>} - Success response
|
|
1800
|
-
* @name getBigQueryHeadersById
|
|
1801
|
-
* @summary: Get BigQuery headers
|
|
1802
|
-
* @description: Retrieves header information from BigQuery. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getBigQueryHeadersById/).
|
|
1803
|
-
*/
|
|
1804
|
-
async getBigQueryHeadersById(
|
|
1805
|
-
{ id, requestHeaders } = { requestHeaders: {} },
|
|
1806
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
1807
|
-
) {
|
|
1808
|
-
const {
|
|
1809
|
-
error,
|
|
1810
|
-
} = CommunicationPlatformApplicationValidator.getBigQueryHeadersById().validate(
|
|
1811
|
-
{
|
|
1812
|
-
id,
|
|
1813
|
-
},
|
|
1814
|
-
{ abortEarly: false, allowUnknown: true }
|
|
1815
|
-
);
|
|
1816
|
-
if (error) {
|
|
1817
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
1818
|
-
}
|
|
1819
|
-
|
|
1820
|
-
// Showing warrnings if extra unknown parameters are found
|
|
1821
|
-
const {
|
|
1822
|
-
error: warrning,
|
|
1823
|
-
} = CommunicationPlatformApplicationValidator.getBigQueryHeadersById().validate(
|
|
1824
|
-
{
|
|
1825
|
-
id,
|
|
1826
|
-
},
|
|
1827
|
-
{ abortEarly: false, allowUnknown: false }
|
|
1828
|
-
);
|
|
1829
|
-
if (warrning) {
|
|
1830
|
-
Logger({
|
|
1831
|
-
level: "WARN",
|
|
1832
|
-
message: `Parameter Validation warrnings for platform > Communication > getBigQueryHeadersById \n ${warrning}`,
|
|
1833
|
-
});
|
|
1834
|
-
}
|
|
1835
|
-
|
|
1836
|
-
const query_params = {};
|
|
1837
|
-
|
|
1838
|
-
const response = await PlatformAPIClient.execute(
|
|
1839
|
-
this.config,
|
|
1840
|
-
"get",
|
|
1841
|
-
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-headers/${id}`,
|
|
1842
|
-
query_params,
|
|
1843
|
-
undefined,
|
|
1844
|
-
requestHeaders,
|
|
1845
|
-
{ responseHeaders }
|
|
1846
|
-
);
|
|
1847
|
-
|
|
1848
|
-
let responseData = response;
|
|
1849
|
-
if (responseHeaders) {
|
|
1850
|
-
responseData = response[0];
|
|
1851
|
-
}
|
|
1852
|
-
|
|
1853
|
-
const { error: res_error } = Joi.any().validate(responseData, {
|
|
1854
|
-
abortEarly: false,
|
|
1855
|
-
allowUnknown: true,
|
|
1856
|
-
});
|
|
1857
|
-
|
|
1858
|
-
if (res_error) {
|
|
1859
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
1860
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1861
|
-
} else {
|
|
1862
|
-
Logger({
|
|
1863
|
-
level: "WARN",
|
|
1864
|
-
message: `Response Validation Warnings for platform > Communication > getBigQueryHeadersById \n ${res_error}`,
|
|
1865
|
-
});
|
|
1866
|
-
}
|
|
1867
|
-
}
|
|
1868
|
-
|
|
1869
|
-
return response;
|
|
1870
|
-
}
|
|
1871
|
-
|
|
1872
|
-
/**
|
|
1873
|
-
* @param {CommunicationPlatformApplicationValidator.GetBigQueryRowCountByIdParam} arg
|
|
1874
|
-
* - Arg object
|
|
1875
|
-
*
|
|
1876
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1877
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1878
|
-
* @returns {Promise<Object>} - Success response
|
|
1879
|
-
* @name getBigQueryRowCountById
|
|
1880
|
-
* @summary: Get BigQuery row count
|
|
1881
|
-
* @description: Retrieves big query row count by id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getBigQueryRowCountById/).
|
|
1882
|
-
*/
|
|
1883
|
-
async getBigQueryRowCountById(
|
|
1884
|
-
{ id, requestHeaders } = { requestHeaders: {} },
|
|
1885
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
1886
|
-
) {
|
|
1887
|
-
const {
|
|
1888
|
-
error,
|
|
1889
|
-
} = CommunicationPlatformApplicationValidator.getBigQueryRowCountById().validate(
|
|
1890
|
-
{
|
|
1891
|
-
id,
|
|
1892
|
-
},
|
|
1893
|
-
{ abortEarly: false, allowUnknown: true }
|
|
1894
|
-
);
|
|
1895
|
-
if (error) {
|
|
1896
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
1897
|
-
}
|
|
1898
|
-
|
|
1899
|
-
// Showing warrnings if extra unknown parameters are found
|
|
1900
|
-
const {
|
|
1901
|
-
error: warrning,
|
|
1902
|
-
} = CommunicationPlatformApplicationValidator.getBigQueryRowCountById().validate(
|
|
1903
|
-
{
|
|
1904
|
-
id,
|
|
1905
|
-
},
|
|
1906
|
-
{ abortEarly: false, allowUnknown: false }
|
|
1907
|
-
);
|
|
1908
|
-
if (warrning) {
|
|
1909
|
-
Logger({
|
|
1910
|
-
level: "WARN",
|
|
1911
|
-
message: `Parameter Validation warrnings for platform > Communication > getBigQueryRowCountById \n ${warrning}`,
|
|
1912
|
-
});
|
|
1913
|
-
}
|
|
1914
|
-
|
|
1915
|
-
const query_params = {};
|
|
1916
|
-
|
|
1917
|
-
const response = await PlatformAPIClient.execute(
|
|
1918
|
-
this.config,
|
|
1919
|
-
"get",
|
|
1920
|
-
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/bigquery-row-count/${id}`,
|
|
1921
|
-
query_params,
|
|
1922
|
-
undefined,
|
|
1923
|
-
requestHeaders,
|
|
1924
|
-
{ responseHeaders }
|
|
1925
|
-
);
|
|
1926
|
-
|
|
1927
|
-
let responseData = response;
|
|
1928
|
-
if (responseHeaders) {
|
|
1929
|
-
responseData = response[0];
|
|
1930
|
-
}
|
|
1931
|
-
|
|
1932
|
-
const { error: res_error } = Joi.any().validate(responseData, {
|
|
1933
|
-
abortEarly: false,
|
|
1934
|
-
allowUnknown: true,
|
|
1935
|
-
});
|
|
1936
|
-
|
|
1937
|
-
if (res_error) {
|
|
1938
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
1939
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1940
|
-
} else {
|
|
1941
|
-
Logger({
|
|
1942
|
-
level: "WARN",
|
|
1943
|
-
message: `Response Validation Warnings for platform > Communication > getBigQueryRowCountById \n ${res_error}`,
|
|
1944
|
-
});
|
|
1945
|
-
}
|
|
1946
|
-
}
|
|
1947
|
-
|
|
1948
|
-
return response;
|
|
1949
|
-
}
|
|
1950
|
-
|
|
1951
1568
|
/**
|
|
1952
1569
|
* @param {CommunicationPlatformApplicationValidator.GetCampaignByIdParam} arg
|
|
1953
1570
|
* - Arg object
|
|
@@ -2806,7 +2423,7 @@ class Communication {
|
|
|
2806
2423
|
populate,
|
|
2807
2424
|
group,
|
|
2808
2425
|
subGroup,
|
|
2809
|
-
|
|
2426
|
+
fulfillmentOptionSlug,
|
|
2810
2427
|
requestHeaders,
|
|
2811
2428
|
} = { requestHeaders: {} },
|
|
2812
2429
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -2820,7 +2437,7 @@ class Communication {
|
|
|
2820
2437
|
populate,
|
|
2821
2438
|
group,
|
|
2822
2439
|
subGroup,
|
|
2823
|
-
|
|
2440
|
+
fulfillmentOptionSlug,
|
|
2824
2441
|
},
|
|
2825
2442
|
{ abortEarly: false, allowUnknown: true }
|
|
2826
2443
|
);
|
|
@@ -2838,7 +2455,7 @@ class Communication {
|
|
|
2838
2455
|
populate,
|
|
2839
2456
|
group,
|
|
2840
2457
|
subGroup,
|
|
2841
|
-
|
|
2458
|
+
fulfillmentOptionSlug,
|
|
2842
2459
|
},
|
|
2843
2460
|
{ abortEarly: false, allowUnknown: false }
|
|
2844
2461
|
);
|
|
@@ -2855,7 +2472,7 @@ class Communication {
|
|
|
2855
2472
|
query_params["populate"] = populate;
|
|
2856
2473
|
query_params["group"] = group;
|
|
2857
2474
|
query_params["sub_group"] = subGroup;
|
|
2858
|
-
query_params["
|
|
2475
|
+
query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
|
|
2859
2476
|
|
|
2860
2477
|
const response = await PlatformAPIClient.execute(
|
|
2861
2478
|
this.config,
|
|
@@ -4143,81 +3760,6 @@ class Communication {
|
|
|
4143
3760
|
return response;
|
|
4144
3761
|
}
|
|
4145
3762
|
|
|
4146
|
-
/**
|
|
4147
|
-
* @param {CommunicationPlatformApplicationValidator.GetSystemAudiencesParam} arg
|
|
4148
|
-
* - Arg object
|
|
4149
|
-
*
|
|
4150
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4151
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4152
|
-
* @returns {Promise<Object>} - Success response
|
|
4153
|
-
* @name getSystemAudiences
|
|
4154
|
-
* @summary: Get system audiences
|
|
4155
|
-
* @description: Retrieves a list of system-defined audiences for communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/communication/getSystemAudiences/).
|
|
4156
|
-
*/
|
|
4157
|
-
async getSystemAudiences(
|
|
4158
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
4159
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
4160
|
-
) {
|
|
4161
|
-
const {
|
|
4162
|
-
error,
|
|
4163
|
-
} = CommunicationPlatformApplicationValidator.getSystemAudiences().validate(
|
|
4164
|
-
{},
|
|
4165
|
-
{ abortEarly: false, allowUnknown: true }
|
|
4166
|
-
);
|
|
4167
|
-
if (error) {
|
|
4168
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
4169
|
-
}
|
|
4170
|
-
|
|
4171
|
-
// Showing warrnings if extra unknown parameters are found
|
|
4172
|
-
const {
|
|
4173
|
-
error: warrning,
|
|
4174
|
-
} = CommunicationPlatformApplicationValidator.getSystemAudiences().validate(
|
|
4175
|
-
{},
|
|
4176
|
-
{ abortEarly: false, allowUnknown: false }
|
|
4177
|
-
);
|
|
4178
|
-
if (warrning) {
|
|
4179
|
-
Logger({
|
|
4180
|
-
level: "WARN",
|
|
4181
|
-
message: `Parameter Validation warrnings for platform > Communication > getSystemAudiences \n ${warrning}`,
|
|
4182
|
-
});
|
|
4183
|
-
}
|
|
4184
|
-
|
|
4185
|
-
const query_params = {};
|
|
4186
|
-
|
|
4187
|
-
const response = await PlatformAPIClient.execute(
|
|
4188
|
-
this.config,
|
|
4189
|
-
"get",
|
|
4190
|
-
`/service/platform/communication/v1.0/company/${this.config.companyId}/application/${this.applicationId}/sources/system-datasources`,
|
|
4191
|
-
query_params,
|
|
4192
|
-
undefined,
|
|
4193
|
-
requestHeaders,
|
|
4194
|
-
{ responseHeaders }
|
|
4195
|
-
);
|
|
4196
|
-
|
|
4197
|
-
let responseData = response;
|
|
4198
|
-
if (responseHeaders) {
|
|
4199
|
-
responseData = response[0];
|
|
4200
|
-
}
|
|
4201
|
-
|
|
4202
|
-
const { error: res_error } = Joi.any().validate(responseData, {
|
|
4203
|
-
abortEarly: false,
|
|
4204
|
-
allowUnknown: true,
|
|
4205
|
-
});
|
|
4206
|
-
|
|
4207
|
-
if (res_error) {
|
|
4208
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
4209
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
4210
|
-
} else {
|
|
4211
|
-
Logger({
|
|
4212
|
-
level: "WARN",
|
|
4213
|
-
message: `Response Validation Warnings for platform > Communication > getSystemAudiences \n ${res_error}`,
|
|
4214
|
-
});
|
|
4215
|
-
}
|
|
4216
|
-
}
|
|
4217
|
-
|
|
4218
|
-
return response;
|
|
4219
|
-
}
|
|
4220
|
-
|
|
4221
3763
|
/**
|
|
4222
3764
|
* @param {CommunicationPlatformApplicationValidator.GetSystemEmailTemplatesParam} arg
|
|
4223
3765
|
* - Arg object
|
|
@@ -3,9 +3,6 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
3
3
|
* @typedef CreateAudienceParam
|
|
4
4
|
* @property {CommunicationPlatformModel.AudienceReq} body
|
|
5
5
|
*/
|
|
6
|
-
/** @typedef CreateBigQueryHeadersParam */
|
|
7
|
-
/** @typedef CreateBigQueryNCountParam */
|
|
8
|
-
/** @typedef CreateBigQueryRowCountParam */
|
|
9
6
|
/**
|
|
10
7
|
* @typedef CreateCampaignParam
|
|
11
8
|
* @property {CommunicationPlatformModel.CampaignReq} body
|
|
@@ -80,14 +77,6 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
80
77
|
* @property {Object} [sort] - To sort based on created_at
|
|
81
78
|
* @property {Object} [query] - To search based on plain text
|
|
82
79
|
*/
|
|
83
|
-
/**
|
|
84
|
-
* @typedef GetBigQueryHeadersByIdParam
|
|
85
|
-
* @property {string} id - Audience id
|
|
86
|
-
*/
|
|
87
|
-
/**
|
|
88
|
-
* @typedef GetBigQueryRowCountByIdParam
|
|
89
|
-
* @property {string} id - Audience id
|
|
90
|
-
*/
|
|
91
80
|
/**
|
|
92
81
|
* @typedef GetCampaignByIdParam
|
|
93
82
|
* @property {string} id - Campaign id
|
|
@@ -145,8 +134,9 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
145
134
|
* @property {string} [subGroup] - Filter by event subgroup. Here, a subgroup is
|
|
146
135
|
* a subset within a group, containing specific email and SMS templates for
|
|
147
136
|
* more detailed organization.
|
|
148
|
-
* @property {string} [
|
|
149
|
-
*
|
|
137
|
+
* @property {string} [fulfillmentOptionSlug] - Filter by fulfillment option
|
|
138
|
+
* slug. Indicates the delivery choice selected, e.g., standard-delivery or
|
|
139
|
+
* homedelivery.
|
|
150
140
|
*/
|
|
151
141
|
/**
|
|
152
142
|
* @typedef GetEventSubscriptionsByIdParam
|
|
@@ -213,7 +203,6 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
213
203
|
* @property {number} [pageSize] - Current request items count
|
|
214
204
|
* @property {Object} [query] - To search based on plain text
|
|
215
205
|
*/
|
|
216
|
-
/** @typedef GetSystemAudiencesParam */
|
|
217
206
|
/** @typedef GetSystemEmailTemplatesParam */
|
|
218
207
|
/** @typedef GetSystemSmsTemplatesParam */
|
|
219
208
|
/**
|
|
@@ -278,12 +267,6 @@ export = CommunicationPlatformApplicationValidator;
|
|
|
278
267
|
declare class CommunicationPlatformApplicationValidator {
|
|
279
268
|
/** @returns {CreateAudienceParam} */
|
|
280
269
|
static createAudience(): CreateAudienceParam;
|
|
281
|
-
/** @returns {CreateBigQueryHeadersParam} */
|
|
282
|
-
static createBigQueryHeaders(): any;
|
|
283
|
-
/** @returns {CreateBigQueryNCountParam} */
|
|
284
|
-
static createBigQueryNCount(): any;
|
|
285
|
-
/** @returns {CreateBigQueryRowCountParam} */
|
|
286
|
-
static createBigQueryRowCount(): any;
|
|
287
270
|
/** @returns {CreateCampaignParam} */
|
|
288
271
|
static createCampaign(): CreateCampaignParam;
|
|
289
272
|
/** @returns {CreateEmailProviderParam} */
|
|
@@ -320,10 +303,6 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
320
303
|
static getAudienceById(): GetAudienceByIdParam;
|
|
321
304
|
/** @returns {GetAudiencesParam} */
|
|
322
305
|
static getAudiences(): GetAudiencesParam;
|
|
323
|
-
/** @returns {GetBigQueryHeadersByIdParam} */
|
|
324
|
-
static getBigQueryHeadersById(): GetBigQueryHeadersByIdParam;
|
|
325
|
-
/** @returns {GetBigQueryRowCountByIdParam} */
|
|
326
|
-
static getBigQueryRowCountById(): GetBigQueryRowCountByIdParam;
|
|
327
306
|
/** @returns {GetCampaignByIdParam} */
|
|
328
307
|
static getCampaignById(): GetCampaignByIdParam;
|
|
329
308
|
/** @returns {GetCampaignsParam} */
|
|
@@ -376,8 +355,6 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
376
355
|
static getSubscribedEmailTemplates(): GetSubscribedEmailTemplatesParam;
|
|
377
356
|
/** @returns {GetSubscribedSmsTemplatesParam} */
|
|
378
357
|
static getSubscribedSmsTemplates(): GetSubscribedSmsTemplatesParam;
|
|
379
|
-
/** @returns {GetSystemAudiencesParam} */
|
|
380
|
-
static getSystemAudiences(): any;
|
|
381
358
|
/** @returns {GetSystemEmailTemplatesParam} */
|
|
382
359
|
static getSystemEmailTemplates(): any;
|
|
383
360
|
/** @returns {GetSystemSmsTemplatesParam} */
|
|
@@ -412,7 +389,7 @@ declare class CommunicationPlatformApplicationValidator {
|
|
|
412
389
|
static verfiyOtp(): VerfiyOtpParam;
|
|
413
390
|
}
|
|
414
391
|
declare namespace CommunicationPlatformApplicationValidator {
|
|
415
|
-
export { CreateAudienceParam,
|
|
392
|
+
export { CreateAudienceParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateEventSubscriptionsParam, CreateEventSubscriptionsByBulkParam, CreateJobsParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteAudienceByIdParam, DeleteEmailProviderByIdParam, DeleteEmailTemplateByIdParam, DeleteEventSubscriptionsByIdParam, DeleteSmsProviderByIdParam, DeleteSmsTemplateByIdParam, EditEventSubscriptionsParam, GetAppProvidersParam, GetAudienceByIdParam, GetAudiencesParam, GetCampaignByIdParam, GetCampaignsParam, GetCommunicationLogsParam, GetDefaultSmsProvidersParam, GetDummyDatasourcesParam, GetDummyDatasourcesMetaParam, GetEmailProviderByIdParam, GetEmailProvidersParam, GetEmailTemplateByIdParam, GetEmailTemplatesParam, GetEventSubscriptionsParam, GetEventSubscriptionsByIdParam, GetGlobalProvidersParam, GetGlobalVariablesParam, GetJobLogsParam, GetJobsParam, GetNSampleRecordsFromCsvParam, GetNSampleRecordsFromCsvByGetParam, GetOtpConfigurationParam, GetSmsProviderByIdParam, GetSmsProvidersParam, GetSmsTemplateByIdParam, GetSmsTemplatesParam, GetStatsOfCampaignByIdParam, GetSubscribedEmailTemplatesParam, GetSubscribedSmsTemplatesParam, GetSystemEmailTemplatesParam, GetSystemSmsTemplatesParam, PostGlobalVariablesParam, SendCommunicationAsynchronouslyParam, SendCommunicationSynchronouslyParam, SendOtpParam, TriggerCampaignJobParam, UpdateAppProvidersParam, UpdateAudienceByIdParam, UpdateCampaignByIdParam, UpdateEmailProviderByIdParam, UpdateEmailTemplateByIdParam, UpdateOtpConfigurationParam, UpdateSmsProviderByIdParam, UpdateSmsTemplateByIdParam, VerfiyOtpParam };
|
|
416
393
|
}
|
|
417
394
|
type CreateAudienceParam = {
|
|
418
395
|
body: CommunicationPlatformModel.AudienceReq;
|
|
@@ -509,18 +486,6 @@ type GetAudiencesParam = {
|
|
|
509
486
|
*/
|
|
510
487
|
query?: any;
|
|
511
488
|
};
|
|
512
|
-
type GetBigQueryHeadersByIdParam = {
|
|
513
|
-
/**
|
|
514
|
-
* - Audience id
|
|
515
|
-
*/
|
|
516
|
-
id: string;
|
|
517
|
-
};
|
|
518
|
-
type GetBigQueryRowCountByIdParam = {
|
|
519
|
-
/**
|
|
520
|
-
* - Audience id
|
|
521
|
-
*/
|
|
522
|
-
id: string;
|
|
523
|
-
};
|
|
524
489
|
type GetCampaignByIdParam = {
|
|
525
490
|
/**
|
|
526
491
|
* - Campaign id
|
|
@@ -641,9 +606,10 @@ type GetEventSubscriptionsParam = {
|
|
|
641
606
|
subGroup?: string;
|
|
642
607
|
/**
|
|
643
608
|
* - Filter by fulfillment option
|
|
644
|
-
*
|
|
609
|
+
* slug. Indicates the delivery choice selected, e.g., standard-delivery or
|
|
610
|
+
* homedelivery.
|
|
645
611
|
*/
|
|
646
|
-
|
|
612
|
+
fulfillmentOptionSlug?: string;
|
|
647
613
|
};
|
|
648
614
|
type GetEventSubscriptionsByIdParam = {
|
|
649
615
|
/**
|
|
@@ -839,9 +805,6 @@ type UpdateSmsTemplateByIdParam = {
|
|
|
839
805
|
type VerfiyOtpParam = {
|
|
840
806
|
body: CommunicationPlatformModel.VerifyOtpCommsReq;
|
|
841
807
|
};
|
|
842
|
-
type CreateBigQueryHeadersParam = any;
|
|
843
|
-
type CreateBigQueryNCountParam = any;
|
|
844
|
-
type CreateBigQueryRowCountParam = any;
|
|
845
808
|
type GetAppProvidersParam = any;
|
|
846
809
|
type GetDefaultSmsProvidersParam = any;
|
|
847
810
|
type GetDummyDatasourcesParam = any;
|
|
@@ -849,7 +812,6 @@ type GetGlobalProvidersParam = any;
|
|
|
849
812
|
type GetGlobalVariablesParam = any;
|
|
850
813
|
type GetNSampleRecordsFromCsvByGetParam = any;
|
|
851
814
|
type GetOtpConfigurationParam = any;
|
|
852
|
-
type GetSystemAudiencesParam = any;
|
|
853
815
|
type GetSystemEmailTemplatesParam = any;
|
|
854
816
|
type GetSystemSmsTemplatesParam = any;
|
|
855
817
|
type UpdateOtpConfigurationParam = any;
|