@teemill/platform 0.24.0 → 0.27.0
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 +4 -2
- package/api.ts +298 -18
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +188 -9
- package/dist/api.js +164 -17
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +188 -9
- package/dist/esm/api.js +163 -16
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CustomersApi.md +22 -4
- package/docs/EnquiriesApi.md +67 -0
- package/docs/Enquiry.md +2 -0
- package/docs/OrdersApi.md +7 -1
- package/docs/Statistics.md +2 -0
- package/docs/UpdateCustomerEnquiryRequest.md +20 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.27.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.TermsApi = exports.TermsApiFactory = exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.EnquiriesApi = exports.EnquiriesApiFactory = exports.EnquiriesApiFp = exports.EnquiriesApiAxiosParamCreator = exports.ListCustomersSortByEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = void 0;
|
|
25
|
+
exports.TermsApi = exports.TermsApiFactory = exports.TermsApiFp = exports.TermsApiAxiosParamCreator = exports.ReviewsApi = exports.ReviewsApiFactory = exports.ReviewsApiFp = exports.ReviewsApiAxiosParamCreator = exports.PlatformApi = exports.PlatformApiFactory = exports.PlatformApiFp = exports.PlatformApiAxiosParamCreator = exports.PaymentApi = exports.PaymentApiFactory = exports.PaymentApiFp = exports.PaymentApiAxiosParamCreator = exports.ListOrdersDateFilterTypeEnum = exports.OrdersApi = exports.OrdersApiFactory = exports.OrdersApiFp = exports.OrdersApiAxiosParamCreator = exports.EnquiriesApi = exports.EnquiriesApiFactory = exports.EnquiriesApiFp = exports.EnquiriesApiAxiosParamCreator = exports.ListCustomersGenderEnum = exports.ListCustomersSortByEnum = exports.ExportCustomersSortByEnum = exports.ExportCustomersGenderEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -71,7 +71,10 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
71
71
|
* @summary Export customers
|
|
72
72
|
* @param {string} project Project unique identifier
|
|
73
73
|
* @param {string} platformId The platform identifier
|
|
74
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
75
|
+
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
74
76
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
77
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
75
78
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
76
79
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
77
80
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -79,7 +82,7 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
79
82
|
* @param {*} [options] Override http request option.
|
|
80
83
|
* @throws {RequiredError}
|
|
81
84
|
*/
|
|
82
|
-
exportCustomers: (project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
85
|
+
exportCustomers: (project_1, platformId_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
83
86
|
// verify required parameter 'project' is not null or undefined
|
|
84
87
|
(0, common_1.assertParamExists)('exportCustomers', 'project', project);
|
|
85
88
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -103,9 +106,18 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
103
106
|
if (project !== undefined) {
|
|
104
107
|
localVarQueryParameter['project'] = project;
|
|
105
108
|
}
|
|
109
|
+
if (countries) {
|
|
110
|
+
localVarQueryParameter['countries'] = countries;
|
|
111
|
+
}
|
|
112
|
+
if (gender !== undefined) {
|
|
113
|
+
localVarQueryParameter['gender'] = gender;
|
|
114
|
+
}
|
|
106
115
|
if (totalOrderCount !== undefined) {
|
|
107
116
|
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
108
117
|
}
|
|
118
|
+
if (refundedOrderCount !== undefined) {
|
|
119
|
+
localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
|
|
120
|
+
}
|
|
109
121
|
if (lifetimeValue !== undefined) {
|
|
110
122
|
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
111
123
|
}
|
|
@@ -181,14 +193,17 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
181
193
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
182
194
|
* @param {string} [search] Search term to filter results
|
|
183
195
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
196
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
197
|
+
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
184
198
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
199
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
185
200
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
186
201
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
187
202
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
188
203
|
* @param {*} [options] Override http request option.
|
|
189
204
|
* @throws {RequiredError}
|
|
190
205
|
*/
|
|
191
|
-
listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
206
|
+
listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, gender_1, totalOrderCount_1, refundedOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
192
207
|
// verify required parameter 'project' is not null or undefined
|
|
193
208
|
(0, common_1.assertParamExists)('listCustomers', 'project', project);
|
|
194
209
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -224,9 +239,18 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
224
239
|
if (sortBy) {
|
|
225
240
|
localVarQueryParameter['sortBy'] = sortBy;
|
|
226
241
|
}
|
|
242
|
+
if (countries) {
|
|
243
|
+
localVarQueryParameter['countries'] = countries;
|
|
244
|
+
}
|
|
245
|
+
if (gender !== undefined) {
|
|
246
|
+
localVarQueryParameter['gender'] = gender;
|
|
247
|
+
}
|
|
227
248
|
if (totalOrderCount !== undefined) {
|
|
228
249
|
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
229
250
|
}
|
|
251
|
+
if (refundedOrderCount !== undefined) {
|
|
252
|
+
localVarQueryParameter['refundedOrderCount'] = refundedOrderCount;
|
|
253
|
+
}
|
|
230
254
|
if (lifetimeValue !== undefined) {
|
|
231
255
|
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
232
256
|
}
|
|
@@ -261,7 +285,10 @@ const CustomersApiFp = function (configuration) {
|
|
|
261
285
|
* @summary Export customers
|
|
262
286
|
* @param {string} project Project unique identifier
|
|
263
287
|
* @param {string} platformId The platform identifier
|
|
288
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
289
|
+
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
264
290
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
291
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
265
292
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
266
293
|
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
267
294
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
@@ -269,10 +296,10 @@ const CustomersApiFp = function (configuration) {
|
|
|
269
296
|
* @param {*} [options] Override http request option.
|
|
270
297
|
* @throws {RequiredError}
|
|
271
298
|
*/
|
|
272
|
-
exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
299
|
+
exportCustomers(project, platformId, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
273
300
|
return __awaiter(this, void 0, void 0, function* () {
|
|
274
301
|
var _a, _b, _c;
|
|
275
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
|
|
302
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
|
|
276
303
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
277
304
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.exportCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
278
305
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -305,17 +332,20 @@ const CustomersApiFp = function (configuration) {
|
|
|
305
332
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
306
333
|
* @param {string} [search] Search term to filter results
|
|
307
334
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
335
|
+
* @param {Array<string>} [countries] Filter customers by country code
|
|
336
|
+
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
308
337
|
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
338
|
+
* @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
|
|
309
339
|
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
310
340
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
311
341
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
312
342
|
* @param {*} [options] Override http request option.
|
|
313
343
|
* @throws {RequiredError}
|
|
314
344
|
*/
|
|
315
|
-
listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
345
|
+
listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
316
346
|
return __awaiter(this, void 0, void 0, function* () {
|
|
317
347
|
var _a, _b, _c;
|
|
318
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
348
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, gender, totalOrderCount, refundedOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
319
349
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
320
350
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.listCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
321
351
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -339,7 +369,7 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
339
369
|
* @throws {RequiredError}
|
|
340
370
|
*/
|
|
341
371
|
exportCustomers(requestParameters, options) {
|
|
342
|
-
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
372
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
343
373
|
},
|
|
344
374
|
/**
|
|
345
375
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -359,7 +389,7 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
359
389
|
* @throws {RequiredError}
|
|
360
390
|
*/
|
|
361
391
|
listCustomers(requestParameters, options) {
|
|
362
|
-
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
392
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
363
393
|
},
|
|
364
394
|
};
|
|
365
395
|
};
|
|
@@ -380,7 +410,7 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
380
410
|
* @memberof CustomersApi
|
|
381
411
|
*/
|
|
382
412
|
exportCustomers(requestParameters, options) {
|
|
383
|
-
return (0, exports.CustomersApiFp)(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
413
|
+
return (0, exports.CustomersApiFp)(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
384
414
|
}
|
|
385
415
|
/**
|
|
386
416
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -402,10 +432,17 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
402
432
|
* @memberof CustomersApi
|
|
403
433
|
*/
|
|
404
434
|
listCustomers(requestParameters, options) {
|
|
405
|
-
return (0, exports.CustomersApiFp)(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
435
|
+
return (0, exports.CustomersApiFp)(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.totalOrderCount, requestParameters.refundedOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
406
436
|
}
|
|
407
437
|
}
|
|
408
438
|
exports.CustomersApi = CustomersApi;
|
|
439
|
+
/**
|
|
440
|
+
* @export
|
|
441
|
+
*/
|
|
442
|
+
exports.ExportCustomersGenderEnum = {
|
|
443
|
+
Male: 'male',
|
|
444
|
+
Female: 'female'
|
|
445
|
+
};
|
|
409
446
|
/**
|
|
410
447
|
* @export
|
|
411
448
|
*/
|
|
@@ -414,6 +451,8 @@ exports.ExportCustomersSortByEnum = {
|
|
|
414
451
|
LifetimeValue2: '-lifetimeValue',
|
|
415
452
|
TotalOrderCount: '+totalOrderCount',
|
|
416
453
|
TotalOrderCount2: '-totalOrderCount',
|
|
454
|
+
RefundedOrderCount: '+refundedOrderCount',
|
|
455
|
+
RefundedOrderCount2: '-refundedOrderCount',
|
|
417
456
|
LastPurchased: '+lastPurchased',
|
|
418
457
|
LastPurchased2: '-lastPurchased'
|
|
419
458
|
};
|
|
@@ -425,9 +464,18 @@ exports.ListCustomersSortByEnum = {
|
|
|
425
464
|
LifetimeValue2: '-lifetimeValue',
|
|
426
465
|
TotalOrderCount: '+totalOrderCount',
|
|
427
466
|
TotalOrderCount2: '-totalOrderCount',
|
|
467
|
+
RefundedOrderCount: '+refundedOrderCount',
|
|
468
|
+
RefundedOrderCount2: '-refundedOrderCount',
|
|
428
469
|
LastPurchased: '+lastPurchased',
|
|
429
470
|
LastPurchased2: '-lastPurchased'
|
|
430
471
|
};
|
|
472
|
+
/**
|
|
473
|
+
* @export
|
|
474
|
+
*/
|
|
475
|
+
exports.ListCustomersGenderEnum = {
|
|
476
|
+
Male: 'male',
|
|
477
|
+
Female: 'female'
|
|
478
|
+
};
|
|
431
479
|
/**
|
|
432
480
|
* EnquiriesApi - axios parameter creator
|
|
433
481
|
* @export
|
|
@@ -630,6 +678,55 @@ const EnquiriesApiAxiosParamCreator = function (configuration) {
|
|
|
630
678
|
options: localVarRequestOptions,
|
|
631
679
|
};
|
|
632
680
|
}),
|
|
681
|
+
/**
|
|
682
|
+
* Update a customer enquiry
|
|
683
|
+
* @summary Update customer enquiry
|
|
684
|
+
* @param {string} project Project unique identifier
|
|
685
|
+
* @param {string} platformId The platform identifier
|
|
686
|
+
* @param {string} enquiryId The enquiry identifier
|
|
687
|
+
* @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
|
|
688
|
+
* @param {*} [options] Override http request option.
|
|
689
|
+
* @throws {RequiredError}
|
|
690
|
+
*/
|
|
691
|
+
updateCustomerEnquiry: (project_1, platformId_1, enquiryId_1, updateCustomerEnquiryRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, enquiryId_1, updateCustomerEnquiryRequest_1, ...args_1], void 0, function* (project, platformId, enquiryId, updateCustomerEnquiryRequest, options = {}) {
|
|
692
|
+
// verify required parameter 'project' is not null or undefined
|
|
693
|
+
(0, common_1.assertParamExists)('updateCustomerEnquiry', 'project', project);
|
|
694
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
695
|
+
(0, common_1.assertParamExists)('updateCustomerEnquiry', 'platformId', platformId);
|
|
696
|
+
// verify required parameter 'enquiryId' is not null or undefined
|
|
697
|
+
(0, common_1.assertParamExists)('updateCustomerEnquiry', 'enquiryId', enquiryId);
|
|
698
|
+
// verify required parameter 'updateCustomerEnquiryRequest' is not null or undefined
|
|
699
|
+
(0, common_1.assertParamExists)('updateCustomerEnquiry', 'updateCustomerEnquiryRequest', updateCustomerEnquiryRequest);
|
|
700
|
+
const localVarPath = `/v1/platform/{platformId}/customers/enquiries/{enquiryId}`
|
|
701
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
702
|
+
.replace(`{${"enquiryId"}}`, encodeURIComponent(String(enquiryId)));
|
|
703
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
704
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
705
|
+
let baseOptions;
|
|
706
|
+
if (configuration) {
|
|
707
|
+
baseOptions = configuration.baseOptions;
|
|
708
|
+
}
|
|
709
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
710
|
+
const localVarHeaderParameter = {};
|
|
711
|
+
const localVarQueryParameter = {};
|
|
712
|
+
// authentication session-oauth required
|
|
713
|
+
// oauth required
|
|
714
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
715
|
+
// authentication api-key required
|
|
716
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
717
|
+
if (project !== undefined) {
|
|
718
|
+
localVarQueryParameter['project'] = project;
|
|
719
|
+
}
|
|
720
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
721
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
722
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
723
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
724
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateCustomerEnquiryRequest, localVarRequestOptions, configuration);
|
|
725
|
+
return {
|
|
726
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
727
|
+
options: localVarRequestOptions,
|
|
728
|
+
};
|
|
729
|
+
}),
|
|
633
730
|
};
|
|
634
731
|
};
|
|
635
732
|
exports.EnquiriesApiAxiosParamCreator = EnquiriesApiAxiosParamCreator;
|
|
@@ -716,6 +813,25 @@ const EnquiriesApiFp = function (configuration) {
|
|
|
716
813
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
717
814
|
});
|
|
718
815
|
},
|
|
816
|
+
/**
|
|
817
|
+
* Update a customer enquiry
|
|
818
|
+
* @summary Update customer enquiry
|
|
819
|
+
* @param {string} project Project unique identifier
|
|
820
|
+
* @param {string} platformId The platform identifier
|
|
821
|
+
* @param {string} enquiryId The enquiry identifier
|
|
822
|
+
* @param {UpdateCustomerEnquiryRequest} updateCustomerEnquiryRequest Enquiry update
|
|
823
|
+
* @param {*} [options] Override http request option.
|
|
824
|
+
* @throws {RequiredError}
|
|
825
|
+
*/
|
|
826
|
+
updateCustomerEnquiry(project, platformId, enquiryId, updateCustomerEnquiryRequest, options) {
|
|
827
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
828
|
+
var _a, _b, _c;
|
|
829
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateCustomerEnquiry(project, platformId, enquiryId, updateCustomerEnquiryRequest, options);
|
|
830
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
831
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['EnquiriesApi.updateCustomerEnquiry']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
832
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
833
|
+
});
|
|
834
|
+
},
|
|
719
835
|
};
|
|
720
836
|
};
|
|
721
837
|
exports.EnquiriesApiFp = EnquiriesApiFp;
|
|
@@ -766,6 +882,16 @@ const EnquiriesApiFactory = function (configuration, basePath, axios) {
|
|
|
766
882
|
listCustomerEnquiryLogs(requestParameters, options) {
|
|
767
883
|
return localVarFp.listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(axios, basePath));
|
|
768
884
|
},
|
|
885
|
+
/**
|
|
886
|
+
* Update a customer enquiry
|
|
887
|
+
* @summary Update customer enquiry
|
|
888
|
+
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
889
|
+
* @param {*} [options] Override http request option.
|
|
890
|
+
* @throws {RequiredError}
|
|
891
|
+
*/
|
|
892
|
+
updateCustomerEnquiry(requestParameters, options) {
|
|
893
|
+
return localVarFp.updateCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, requestParameters.updateCustomerEnquiryRequest, options).then((request) => request(axios, basePath));
|
|
894
|
+
},
|
|
769
895
|
};
|
|
770
896
|
};
|
|
771
897
|
exports.EnquiriesApiFactory = EnquiriesApiFactory;
|
|
@@ -820,6 +946,17 @@ class EnquiriesApi extends base_1.BaseAPI {
|
|
|
820
946
|
listCustomerEnquiryLogs(requestParameters, options) {
|
|
821
947
|
return (0, exports.EnquiriesApiFp)(this.configuration).listCustomerEnquiryLogs(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, options).then((request) => request(this.axios, this.basePath));
|
|
822
948
|
}
|
|
949
|
+
/**
|
|
950
|
+
* Update a customer enquiry
|
|
951
|
+
* @summary Update customer enquiry
|
|
952
|
+
* @param {EnquiriesApiUpdateCustomerEnquiryRequest} requestParameters Request parameters.
|
|
953
|
+
* @param {*} [options] Override http request option.
|
|
954
|
+
* @throws {RequiredError}
|
|
955
|
+
* @memberof EnquiriesApi
|
|
956
|
+
*/
|
|
957
|
+
updateCustomerEnquiry(requestParameters, options) {
|
|
958
|
+
return (0, exports.EnquiriesApiFp)(this.configuration).updateCustomerEnquiry(requestParameters.project, requestParameters.platformId, requestParameters.enquiryId, requestParameters.updateCustomerEnquiryRequest, options).then((request) => request(this.axios, this.basePath));
|
|
959
|
+
}
|
|
823
960
|
}
|
|
824
961
|
exports.EnquiriesApi = EnquiriesApi;
|
|
825
962
|
/**
|
|
@@ -1073,10 +1210,12 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1073
1210
|
* @param {string} [start] Start of date range to filter when orders were placed
|
|
1074
1211
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1075
1212
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1213
|
+
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
1214
|
+
* @param {number} [minOrderTotal] The minimum value of the order
|
|
1076
1215
|
* @param {*} [options] Override http request option.
|
|
1077
1216
|
* @throws {RequiredError}
|
|
1078
1217
|
*/
|
|
1079
|
-
listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, options = {}) {
|
|
1218
|
+
listOrders: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, start_1, end_1, dateFilterType_1, maxOrderTotal_1, minOrderTotal_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options = {}) {
|
|
1080
1219
|
// verify required parameter 'project' is not null or undefined
|
|
1081
1220
|
(0, common_1.assertParamExists)('listOrders', 'project', project);
|
|
1082
1221
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1122,6 +1261,12 @@ const OrdersApiAxiosParamCreator = function (configuration) {
|
|
|
1122
1261
|
if (dateFilterType !== undefined) {
|
|
1123
1262
|
localVarQueryParameter['dateFilterType'] = dateFilterType;
|
|
1124
1263
|
}
|
|
1264
|
+
if (maxOrderTotal !== undefined) {
|
|
1265
|
+
localVarQueryParameter['maxOrderTotal'] = maxOrderTotal;
|
|
1266
|
+
}
|
|
1267
|
+
if (minOrderTotal !== undefined) {
|
|
1268
|
+
localVarQueryParameter['minOrderTotal'] = minOrderTotal;
|
|
1269
|
+
}
|
|
1125
1270
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1126
1271
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1127
1272
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -1380,13 +1525,15 @@ const OrdersApiFp = function (configuration) {
|
|
|
1380
1525
|
* @param {string} [start] Start of date range to filter when orders were placed
|
|
1381
1526
|
* @param {string} [end] End of date range to filter when orders were placed
|
|
1382
1527
|
* @param {ListOrdersDateFilterTypeEnum} [dateFilterType] Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query.
|
|
1528
|
+
* @param {number} [maxOrderTotal] The maximum value of the order
|
|
1529
|
+
* @param {number} [minOrderTotal] The minimum value of the order
|
|
1383
1530
|
* @param {*} [options] Override http request option.
|
|
1384
1531
|
* @throws {RequiredError}
|
|
1385
1532
|
*/
|
|
1386
|
-
listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, options) {
|
|
1533
|
+
listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options) {
|
|
1387
1534
|
return __awaiter(this, void 0, void 0, function* () {
|
|
1388
1535
|
var _a, _b, _c;
|
|
1389
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, options);
|
|
1536
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, dateFilterType, maxOrderTotal, minOrderTotal, options);
|
|
1390
1537
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
1391
1538
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrdersApi.listOrders']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
1392
1539
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1515,7 +1662,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
|
|
|
1515
1662
|
* @throws {RequiredError}
|
|
1516
1663
|
*/
|
|
1517
1664
|
listOrders(requestParameters, options) {
|
|
1518
|
-
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(axios, basePath));
|
|
1665
|
+
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(axios, basePath));
|
|
1519
1666
|
},
|
|
1520
1667
|
/**
|
|
1521
1668
|
* Retries failed platform payment, so fulfillment can proceed.
|
|
@@ -1621,7 +1768,7 @@ class OrdersApi extends base_1.BaseAPI {
|
|
|
1621
1768
|
* @memberof OrdersApi
|
|
1622
1769
|
*/
|
|
1623
1770
|
listOrders(requestParameters, options) {
|
|
1624
|
-
return (0, exports.OrdersApiFp)(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, options).then((request) => request(this.axios, this.basePath));
|
|
1771
|
+
return (0, exports.OrdersApiFp)(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, requestParameters.dateFilterType, requestParameters.maxOrderTotal, requestParameters.minOrderTotal, options).then((request) => request(this.axios, this.basePath));
|
|
1625
1772
|
}
|
|
1626
1773
|
/**
|
|
1627
1774
|
* Retries failed platform payment, so fulfillment can proceed.
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED