@teemill/platform 0.33.0 → 0.34.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 +7 -2
- package/api.ts +320 -16
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +226 -11
- package/dist/api.js +129 -12
- 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 +226 -11
- package/dist/esm/api.js +128 -11
- 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/AmendOrderRequestAmendmentsInner.md +2 -0
- package/docs/AmendOrderRequestAmendmentsInnerReason.md +22 -0
- package/docs/CustomersApi.md +81 -0
- package/docs/InlineObject1.md +4 -2
- package/docs/InlineObject2.md +20 -0
- package/docs/PaymentApi.md +2 -2
- package/docs/ReturnOrderRequest.md +1 -1
- package/docs/ReturnOrderRequestReturnsInner.md +28 -0
- package/docs/ReturnOrderRequestReturnsInnerReason.md +22 -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.34.1
|
|
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.PixelsApi = exports.PixelsApiFactory = exports.PixelsApiFp = exports.PixelsApiAxiosParamCreator = 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.DashboardApi = exports.DashboardApiFactory = exports.DashboardApiFp = exports.DashboardApiAxiosParamCreator = exports.ListCustomersGenderEnum = exports.ListCustomersSortByEnum = exports.ExportCustomersGenderEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.AmendmentLogAmendmentTypeEnum = exports.AmendOrderRequestAmendmentsInnerActionEnum = 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.PixelsApi = exports.PixelsApiFactory = exports.PixelsApiFp = exports.PixelsApiAxiosParamCreator = 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.DashboardApi = exports.DashboardApiFactory = exports.DashboardApiFp = exports.DashboardApiAxiosParamCreator = exports.ListCustomersGenderEnum = exports.ListCustomersSortByEnum = exports.ExportCustomersGenderEnum = exports.ExportCustomersSortByEnum = exports.CustomersApi = exports.CustomersApiFactory = exports.CustomersApiFp = exports.CustomersApiAxiosParamCreator = exports.ReturnOrderRequestReturnsInnerActionEnum = exports.PaymentAttemptStatusEnum = exports.PaymentAttemptPaymentProviderEnum = exports.PaymentAccountMethodEnum = exports.OrderStatus = exports.EnquiryStatusEnum = exports.CustomsInformationPreRegistrationTypeEnum = exports.AmendmentLogAmendmentTypeEnum = exports.AmendOrderRequestAmendmentsInnerActionEnum = void 0;
|
|
26
26
|
const axios_1 = require("axios");
|
|
27
27
|
// Some imports not used depending on template conditions
|
|
28
28
|
// @ts-ignore
|
|
@@ -71,6 +71,10 @@ exports.PaymentAttemptStatusEnum = {
|
|
|
71
71
|
Pending: 'pending',
|
|
72
72
|
Cancelled: 'cancelled'
|
|
73
73
|
};
|
|
74
|
+
exports.ReturnOrderRequestReturnsInnerActionEnum = {
|
|
75
|
+
Refund: 'refund',
|
|
76
|
+
Exchange: 'exchange'
|
|
77
|
+
};
|
|
74
78
|
/**
|
|
75
79
|
* CustomersApi - axios parameter creator
|
|
76
80
|
* @export
|
|
@@ -87,6 +91,8 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
87
91
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
88
92
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
89
93
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
94
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
95
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
90
96
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
91
97
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
92
98
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -99,7 +105,7 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
99
105
|
* @param {*} [options] Override http request option.
|
|
100
106
|
* @throws {RequiredError}
|
|
101
107
|
*/
|
|
102
|
-
exportCustomers: (project_1, platformId_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
108
|
+
exportCustomers: (project_1, platformId_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, demographics_1, tags_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, demographics_1, tags_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
103
109
|
// verify required parameter 'project' is not null or undefined
|
|
104
110
|
(0, common_1.assertParamExists)('exportCustomers', 'project', project);
|
|
105
111
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -138,6 +144,12 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
138
144
|
if (productTypes) {
|
|
139
145
|
localVarQueryParameter['productTypes'] = productTypes;
|
|
140
146
|
}
|
|
147
|
+
if (demographics) {
|
|
148
|
+
localVarQueryParameter['demographics'] = demographics;
|
|
149
|
+
}
|
|
150
|
+
if (tags) {
|
|
151
|
+
localVarQueryParameter['tags'] = tags;
|
|
152
|
+
}
|
|
141
153
|
if (usedDiscount !== undefined) {
|
|
142
154
|
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
143
155
|
}
|
|
@@ -219,6 +231,58 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
219
231
|
options: localVarRequestOptions,
|
|
220
232
|
};
|
|
221
233
|
}),
|
|
234
|
+
/**
|
|
235
|
+
* List customer tags
|
|
236
|
+
* @summary List customer tags
|
|
237
|
+
* @param {string} project Project unique identifier
|
|
238
|
+
* @param {string} platformId The platform identifier
|
|
239
|
+
* @param {number} [pageToken] Page reference token
|
|
240
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
241
|
+
* @param {string} [search] Search term to filter results
|
|
242
|
+
* @param {*} [options] Override http request option.
|
|
243
|
+
* @throws {RequiredError}
|
|
244
|
+
*/
|
|
245
|
+
listCustomerTags: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, options = {}) {
|
|
246
|
+
// verify required parameter 'project' is not null or undefined
|
|
247
|
+
(0, common_1.assertParamExists)('listCustomerTags', 'project', project);
|
|
248
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
249
|
+
(0, common_1.assertParamExists)('listCustomerTags', 'platformId', platformId);
|
|
250
|
+
const localVarPath = `/v1/platform/{platformId}/customers/tags`
|
|
251
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
252
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
253
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
254
|
+
let baseOptions;
|
|
255
|
+
if (configuration) {
|
|
256
|
+
baseOptions = configuration.baseOptions;
|
|
257
|
+
}
|
|
258
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
259
|
+
const localVarHeaderParameter = {};
|
|
260
|
+
const localVarQueryParameter = {};
|
|
261
|
+
// authentication session-oauth required
|
|
262
|
+
// oauth required
|
|
263
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
264
|
+
// authentication api-key required
|
|
265
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
266
|
+
if (project !== undefined) {
|
|
267
|
+
localVarQueryParameter['project'] = project;
|
|
268
|
+
}
|
|
269
|
+
if (pageToken !== undefined) {
|
|
270
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
271
|
+
}
|
|
272
|
+
if (pageSize !== undefined) {
|
|
273
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
274
|
+
}
|
|
275
|
+
if (search !== undefined) {
|
|
276
|
+
localVarQueryParameter['search'] = search;
|
|
277
|
+
}
|
|
278
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
279
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
280
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
281
|
+
return {
|
|
282
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
283
|
+
options: localVarRequestOptions,
|
|
284
|
+
};
|
|
285
|
+
}),
|
|
222
286
|
/**
|
|
223
287
|
* List customers for a platform
|
|
224
288
|
* @summary List customers
|
|
@@ -232,6 +296,8 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
232
296
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
233
297
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
234
298
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
299
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
300
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
235
301
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
236
302
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
237
303
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -244,7 +310,7 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
244
310
|
* @param {*} [options] Override http request option.
|
|
245
311
|
* @throws {RequiredError}
|
|
246
312
|
*/
|
|
247
|
-
listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
313
|
+
listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, demographics_1, tags_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, countries_1, projects_1, gender_1, productTypes_1, demographics_1, tags_1, usedDiscount_1, minimumTotalOrderCount_1, maximumTotalOrderCount_1, minimumRefundedOrderCount_1, maximumRefundedOrderCount_1, minimumLifetimeValue_1, maximumLifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
|
|
248
314
|
// verify required parameter 'project' is not null or undefined
|
|
249
315
|
(0, common_1.assertParamExists)('listCustomers', 'project', project);
|
|
250
316
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -292,6 +358,12 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
292
358
|
if (productTypes) {
|
|
293
359
|
localVarQueryParameter['productTypes'] = productTypes;
|
|
294
360
|
}
|
|
361
|
+
if (demographics) {
|
|
362
|
+
localVarQueryParameter['demographics'] = demographics;
|
|
363
|
+
}
|
|
364
|
+
if (tags) {
|
|
365
|
+
localVarQueryParameter['tags'] = tags;
|
|
366
|
+
}
|
|
295
367
|
if (usedDiscount !== undefined) {
|
|
296
368
|
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
297
369
|
}
|
|
@@ -349,6 +421,8 @@ const CustomersApiFp = function (configuration) {
|
|
|
349
421
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
350
422
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
351
423
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
424
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
425
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
352
426
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
353
427
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
354
428
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -361,10 +435,10 @@ const CustomersApiFp = function (configuration) {
|
|
|
361
435
|
* @param {*} [options] Override http request option.
|
|
362
436
|
* @throws {RequiredError}
|
|
363
437
|
*/
|
|
364
|
-
exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
438
|
+
exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
365
439
|
return __awaiter(this, void 0, void 0, function* () {
|
|
366
440
|
var _a, _b, _c;
|
|
367
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
441
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
368
442
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
369
443
|
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;
|
|
370
444
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -388,6 +462,26 @@ const CustomersApiFp = function (configuration) {
|
|
|
388
462
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
389
463
|
});
|
|
390
464
|
},
|
|
465
|
+
/**
|
|
466
|
+
* List customer tags
|
|
467
|
+
* @summary List customer tags
|
|
468
|
+
* @param {string} project Project unique identifier
|
|
469
|
+
* @param {string} platformId The platform identifier
|
|
470
|
+
* @param {number} [pageToken] Page reference token
|
|
471
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
472
|
+
* @param {string} [search] Search term to filter results
|
|
473
|
+
* @param {*} [options] Override http request option.
|
|
474
|
+
* @throws {RequiredError}
|
|
475
|
+
*/
|
|
476
|
+
listCustomerTags(project, platformId, pageToken, pageSize, search, options) {
|
|
477
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
478
|
+
var _a, _b, _c;
|
|
479
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomerTags(project, platformId, pageToken, pageSize, search, options);
|
|
480
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
481
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.listCustomerTags']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
482
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
483
|
+
});
|
|
484
|
+
},
|
|
391
485
|
/**
|
|
392
486
|
* List customers for a platform
|
|
393
487
|
* @summary List customers
|
|
@@ -401,6 +495,8 @@ const CustomersApiFp = function (configuration) {
|
|
|
401
495
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
402
496
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
403
497
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
498
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
499
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
404
500
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
405
501
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
406
502
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -413,10 +509,10 @@ const CustomersApiFp = function (configuration) {
|
|
|
413
509
|
* @param {*} [options] Override http request option.
|
|
414
510
|
* @throws {RequiredError}
|
|
415
511
|
*/
|
|
416
|
-
listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
512
|
+
listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
417
513
|
return __awaiter(this, void 0, void 0, function* () {
|
|
418
514
|
var _a, _b, _c;
|
|
419
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
515
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
420
516
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
421
517
|
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;
|
|
422
518
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -440,7 +536,7 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
440
536
|
* @throws {RequiredError}
|
|
441
537
|
*/
|
|
442
538
|
exportCustomers(requestParameters, options) {
|
|
443
|
-
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
539
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
444
540
|
},
|
|
445
541
|
/**
|
|
446
542
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -452,6 +548,16 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
452
548
|
getCustomer(requestParameters, options) {
|
|
453
549
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
454
550
|
},
|
|
551
|
+
/**
|
|
552
|
+
* List customer tags
|
|
553
|
+
* @summary List customer tags
|
|
554
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
555
|
+
* @param {*} [options] Override http request option.
|
|
556
|
+
* @throws {RequiredError}
|
|
557
|
+
*/
|
|
558
|
+
listCustomerTags(requestParameters, options) {
|
|
559
|
+
return localVarFp.listCustomerTags(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
560
|
+
},
|
|
455
561
|
/**
|
|
456
562
|
* List customers for a platform
|
|
457
563
|
* @summary List customers
|
|
@@ -460,7 +566,7 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
460
566
|
* @throws {RequiredError}
|
|
461
567
|
*/
|
|
462
568
|
listCustomers(requestParameters, options) {
|
|
463
|
-
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
569
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
464
570
|
},
|
|
465
571
|
};
|
|
466
572
|
};
|
|
@@ -481,7 +587,7 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
481
587
|
* @memberof CustomersApi
|
|
482
588
|
*/
|
|
483
589
|
exportCustomers(requestParameters, options) {
|
|
484
|
-
return (0, exports.CustomersApiFp)(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
590
|
+
return (0, exports.CustomersApiFp)(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
485
591
|
}
|
|
486
592
|
/**
|
|
487
593
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -494,6 +600,17 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
494
600
|
getCustomer(requestParameters, options) {
|
|
495
601
|
return (0, exports.CustomersApiFp)(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
496
602
|
}
|
|
603
|
+
/**
|
|
604
|
+
* List customer tags
|
|
605
|
+
* @summary List customer tags
|
|
606
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
607
|
+
* @param {*} [options] Override http request option.
|
|
608
|
+
* @throws {RequiredError}
|
|
609
|
+
* @memberof CustomersApi
|
|
610
|
+
*/
|
|
611
|
+
listCustomerTags(requestParameters, options) {
|
|
612
|
+
return (0, exports.CustomersApiFp)(this.configuration).listCustomerTags(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
613
|
+
}
|
|
497
614
|
/**
|
|
498
615
|
* List customers for a platform
|
|
499
616
|
* @summary List customers
|
|
@@ -503,7 +620,7 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
503
620
|
* @memberof CustomersApi
|
|
504
621
|
*/
|
|
505
622
|
listCustomers(requestParameters, options) {
|
|
506
|
-
return (0, exports.CustomersApiFp)(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
623
|
+
return (0, exports.CustomersApiFp)(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
507
624
|
}
|
|
508
625
|
}
|
|
509
626
|
exports.CustomersApi = CustomersApi;
|
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