@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/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.34.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -68,6 +68,10 @@ export const PaymentAttemptStatusEnum = {
|
|
|
68
68
|
Pending: 'pending',
|
|
69
69
|
Cancelled: 'cancelled'
|
|
70
70
|
};
|
|
71
|
+
export const ReturnOrderRequestReturnsInnerActionEnum = {
|
|
72
|
+
Refund: 'refund',
|
|
73
|
+
Exchange: 'exchange'
|
|
74
|
+
};
|
|
71
75
|
/**
|
|
72
76
|
* CustomersApi - axios parameter creator
|
|
73
77
|
* @export
|
|
@@ -84,6 +88,8 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
84
88
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
85
89
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
86
90
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
91
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
92
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
87
93
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
88
94
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
89
95
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -96,7 +102,7 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
96
102
|
* @param {*} [options] Override http request option.
|
|
97
103
|
* @throws {RequiredError}
|
|
98
104
|
*/
|
|
99
|
-
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 = {}) {
|
|
105
|
+
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 = {}) {
|
|
100
106
|
// verify required parameter 'project' is not null or undefined
|
|
101
107
|
assertParamExists('exportCustomers', 'project', project);
|
|
102
108
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -135,6 +141,12 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
135
141
|
if (productTypes) {
|
|
136
142
|
localVarQueryParameter['productTypes'] = productTypes;
|
|
137
143
|
}
|
|
144
|
+
if (demographics) {
|
|
145
|
+
localVarQueryParameter['demographics'] = demographics;
|
|
146
|
+
}
|
|
147
|
+
if (tags) {
|
|
148
|
+
localVarQueryParameter['tags'] = tags;
|
|
149
|
+
}
|
|
138
150
|
if (usedDiscount !== undefined) {
|
|
139
151
|
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
140
152
|
}
|
|
@@ -216,6 +228,58 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
216
228
|
options: localVarRequestOptions,
|
|
217
229
|
};
|
|
218
230
|
}),
|
|
231
|
+
/**
|
|
232
|
+
* List customer tags
|
|
233
|
+
* @summary List customer tags
|
|
234
|
+
* @param {string} project Project unique identifier
|
|
235
|
+
* @param {string} platformId The platform identifier
|
|
236
|
+
* @param {number} [pageToken] Page reference token
|
|
237
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
238
|
+
* @param {string} [search] Search term to filter results
|
|
239
|
+
* @param {*} [options] Override http request option.
|
|
240
|
+
* @throws {RequiredError}
|
|
241
|
+
*/
|
|
242
|
+
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 = {}) {
|
|
243
|
+
// verify required parameter 'project' is not null or undefined
|
|
244
|
+
assertParamExists('listCustomerTags', 'project', project);
|
|
245
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
246
|
+
assertParamExists('listCustomerTags', 'platformId', platformId);
|
|
247
|
+
const localVarPath = `/v1/platform/{platformId}/customers/tags`
|
|
248
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
249
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
250
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
251
|
+
let baseOptions;
|
|
252
|
+
if (configuration) {
|
|
253
|
+
baseOptions = configuration.baseOptions;
|
|
254
|
+
}
|
|
255
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
256
|
+
const localVarHeaderParameter = {};
|
|
257
|
+
const localVarQueryParameter = {};
|
|
258
|
+
// authentication session-oauth required
|
|
259
|
+
// oauth required
|
|
260
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
261
|
+
// authentication api-key required
|
|
262
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
263
|
+
if (project !== undefined) {
|
|
264
|
+
localVarQueryParameter['project'] = project;
|
|
265
|
+
}
|
|
266
|
+
if (pageToken !== undefined) {
|
|
267
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
268
|
+
}
|
|
269
|
+
if (pageSize !== undefined) {
|
|
270
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
271
|
+
}
|
|
272
|
+
if (search !== undefined) {
|
|
273
|
+
localVarQueryParameter['search'] = search;
|
|
274
|
+
}
|
|
275
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
276
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
277
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
278
|
+
return {
|
|
279
|
+
url: toPathString(localVarUrlObj),
|
|
280
|
+
options: localVarRequestOptions,
|
|
281
|
+
};
|
|
282
|
+
}),
|
|
219
283
|
/**
|
|
220
284
|
* List customers for a platform
|
|
221
285
|
* @summary List customers
|
|
@@ -229,6 +293,8 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
229
293
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
230
294
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
231
295
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
296
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
297
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
232
298
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
233
299
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
234
300
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -241,7 +307,7 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
241
307
|
* @param {*} [options] Override http request option.
|
|
242
308
|
* @throws {RequiredError}
|
|
243
309
|
*/
|
|
244
|
-
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 = {}) {
|
|
310
|
+
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 = {}) {
|
|
245
311
|
// verify required parameter 'project' is not null or undefined
|
|
246
312
|
assertParamExists('listCustomers', 'project', project);
|
|
247
313
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -289,6 +355,12 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
289
355
|
if (productTypes) {
|
|
290
356
|
localVarQueryParameter['productTypes'] = productTypes;
|
|
291
357
|
}
|
|
358
|
+
if (demographics) {
|
|
359
|
+
localVarQueryParameter['demographics'] = demographics;
|
|
360
|
+
}
|
|
361
|
+
if (tags) {
|
|
362
|
+
localVarQueryParameter['tags'] = tags;
|
|
363
|
+
}
|
|
292
364
|
if (usedDiscount !== undefined) {
|
|
293
365
|
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
294
366
|
}
|
|
@@ -345,6 +417,8 @@ export const CustomersApiFp = function (configuration) {
|
|
|
345
417
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
346
418
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
347
419
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
420
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
421
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
348
422
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
349
423
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
350
424
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -357,10 +431,10 @@ export const CustomersApiFp = function (configuration) {
|
|
|
357
431
|
* @param {*} [options] Override http request option.
|
|
358
432
|
* @throws {RequiredError}
|
|
359
433
|
*/
|
|
360
|
-
exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
434
|
+
exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
361
435
|
return __awaiter(this, void 0, void 0, function* () {
|
|
362
436
|
var _a, _b, _c;
|
|
363
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
437
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
364
438
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
365
439
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.exportCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
366
440
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -384,6 +458,26 @@ export const CustomersApiFp = function (configuration) {
|
|
|
384
458
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
385
459
|
});
|
|
386
460
|
},
|
|
461
|
+
/**
|
|
462
|
+
* List customer tags
|
|
463
|
+
* @summary List customer tags
|
|
464
|
+
* @param {string} project Project unique identifier
|
|
465
|
+
* @param {string} platformId The platform identifier
|
|
466
|
+
* @param {number} [pageToken] Page reference token
|
|
467
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
468
|
+
* @param {string} [search] Search term to filter results
|
|
469
|
+
* @param {*} [options] Override http request option.
|
|
470
|
+
* @throws {RequiredError}
|
|
471
|
+
*/
|
|
472
|
+
listCustomerTags(project, platformId, pageToken, pageSize, search, options) {
|
|
473
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
474
|
+
var _a, _b, _c;
|
|
475
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomerTags(project, platformId, pageToken, pageSize, search, options);
|
|
476
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
477
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.listCustomerTags']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
478
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
479
|
+
});
|
|
480
|
+
},
|
|
387
481
|
/**
|
|
388
482
|
* List customers for a platform
|
|
389
483
|
* @summary List customers
|
|
@@ -397,6 +491,8 @@ export const CustomersApiFp = function (configuration) {
|
|
|
397
491
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
398
492
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
399
493
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
494
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
495
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
400
496
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
401
497
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
402
498
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -409,10 +505,10 @@ export const CustomersApiFp = function (configuration) {
|
|
|
409
505
|
* @param {*} [options] Override http request option.
|
|
410
506
|
* @throws {RequiredError}
|
|
411
507
|
*/
|
|
412
|
-
listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
508
|
+
listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
|
|
413
509
|
return __awaiter(this, void 0, void 0, function* () {
|
|
414
510
|
var _a, _b, _c;
|
|
415
|
-
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);
|
|
511
|
+
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);
|
|
416
512
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
417
513
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.listCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
418
514
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -435,7 +531,7 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
435
531
|
* @throws {RequiredError}
|
|
436
532
|
*/
|
|
437
533
|
exportCustomers(requestParameters, options) {
|
|
438
|
-
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));
|
|
534
|
+
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));
|
|
439
535
|
},
|
|
440
536
|
/**
|
|
441
537
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -447,6 +543,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
447
543
|
getCustomer(requestParameters, options) {
|
|
448
544
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
449
545
|
},
|
|
546
|
+
/**
|
|
547
|
+
* List customer tags
|
|
548
|
+
* @summary List customer tags
|
|
549
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
550
|
+
* @param {*} [options] Override http request option.
|
|
551
|
+
* @throws {RequiredError}
|
|
552
|
+
*/
|
|
553
|
+
listCustomerTags(requestParameters, options) {
|
|
554
|
+
return localVarFp.listCustomerTags(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
555
|
+
},
|
|
450
556
|
/**
|
|
451
557
|
* List customers for a platform
|
|
452
558
|
* @summary List customers
|
|
@@ -455,7 +561,7 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
455
561
|
* @throws {RequiredError}
|
|
456
562
|
*/
|
|
457
563
|
listCustomers(requestParameters, options) {
|
|
458
|
-
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));
|
|
564
|
+
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));
|
|
459
565
|
},
|
|
460
566
|
};
|
|
461
567
|
};
|
|
@@ -475,7 +581,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
475
581
|
* @memberof CustomersApi
|
|
476
582
|
*/
|
|
477
583
|
exportCustomers(requestParameters, options) {
|
|
478
|
-
return 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));
|
|
584
|
+
return 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));
|
|
479
585
|
}
|
|
480
586
|
/**
|
|
481
587
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -488,6 +594,17 @@ export class CustomersApi extends BaseAPI {
|
|
|
488
594
|
getCustomer(requestParameters, options) {
|
|
489
595
|
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
490
596
|
}
|
|
597
|
+
/**
|
|
598
|
+
* List customer tags
|
|
599
|
+
* @summary List customer tags
|
|
600
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
601
|
+
* @param {*} [options] Override http request option.
|
|
602
|
+
* @throws {RequiredError}
|
|
603
|
+
* @memberof CustomersApi
|
|
604
|
+
*/
|
|
605
|
+
listCustomerTags(requestParameters, options) {
|
|
606
|
+
return CustomersApiFp(this.configuration).listCustomerTags(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
607
|
+
}
|
|
491
608
|
/**
|
|
492
609
|
* List customers for a platform
|
|
493
610
|
* @summary List customers
|
|
@@ -497,7 +614,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
497
614
|
* @memberof CustomersApi
|
|
498
615
|
*/
|
|
499
616
|
listCustomers(requestParameters, options) {
|
|
500
|
-
return 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));
|
|
617
|
+
return 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));
|
|
501
618
|
}
|
|
502
619
|
}
|
|
503
620
|
/**
|
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**action** | **string** | | [default to undefined]
|
|
10
10
|
**quantity** | **number** | The quantity of the item to refund or exchange. This must be less than or equal to the quantity of the item in the order. | [default to undefined]
|
|
11
11
|
**newVariantRef** | **string** | A reference to the variant being ordered | [optional] [default to undefined]
|
|
12
|
+
**reason** | [**AmendOrderRequestAmendmentsInnerReason**](AmendOrderRequestAmendmentsInnerReason.md) | | [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -20,6 +21,7 @@ const instance: AmendOrderRequestAmendmentsInner = {
|
|
|
20
21
|
action,
|
|
21
22
|
quantity,
|
|
22
23
|
newVariantRef,
|
|
24
|
+
reason,
|
|
23
25
|
};
|
|
24
26
|
```
|
|
25
27
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# AmendOrderRequestAmendmentsInnerReason
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**reasonRef** | **string** | A reference to the resource location | [default to undefined]
|
|
9
|
+
**additionalComments** | **string** | Additional comments as to why the item is being returned or exchanged. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { AmendOrderRequestAmendmentsInnerReason } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: AmendOrderRequestAmendmentsInnerReason = {
|
|
17
|
+
reasonRef,
|
|
18
|
+
additionalComments,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/CustomersApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**exportCustomers**](#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers|
|
|
8
8
|
|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
|
|
9
|
+
|[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
|
|
9
10
|
|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
|
|
10
11
|
|
|
11
12
|
# **exportCustomers**
|
|
@@ -31,6 +32,8 @@ let countries: Array<string>; //Filter customers by country code (optional) (def
|
|
|
31
32
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
32
33
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
33
34
|
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
35
|
+
let demographics: Array<string>; //Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
36
|
+
let tags: Array<string>; //Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
34
37
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
35
38
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
36
39
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -49,6 +52,8 @@ const { status, data } = await apiInstance.exportCustomers(
|
|
|
49
52
|
projects,
|
|
50
53
|
gender,
|
|
51
54
|
productTypes,
|
|
55
|
+
demographics,
|
|
56
|
+
tags,
|
|
52
57
|
usedDiscount,
|
|
53
58
|
minimumTotalOrderCount,
|
|
54
59
|
maximumTotalOrderCount,
|
|
@@ -72,6 +77,8 @@ const { status, data } = await apiInstance.exportCustomers(
|
|
|
72
77
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
73
78
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
74
79
|
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
80
|
+
| **demographics** | **Array<string>** | Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
81
|
+
| **tags** | **Array<string>** | Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
75
82
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
76
83
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
77
84
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
|
@@ -171,6 +178,74 @@ const { status, data } = await apiInstance.getCustomer(
|
|
|
171
178
|
|
|
172
179
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
173
180
|
|
|
181
|
+
# **listCustomerTags**
|
|
182
|
+
> InlineObject1 listCustomerTags()
|
|
183
|
+
|
|
184
|
+
List customer tags
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import {
|
|
190
|
+
CustomersApi,
|
|
191
|
+
Configuration
|
|
192
|
+
} from '@teemill/platform';
|
|
193
|
+
|
|
194
|
+
const configuration = new Configuration();
|
|
195
|
+
const apiInstance = new CustomersApi(configuration);
|
|
196
|
+
|
|
197
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
198
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
199
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
200
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
201
|
+
let search: string; //Search term to filter results (optional) (default to undefined)
|
|
202
|
+
|
|
203
|
+
const { status, data } = await apiInstance.listCustomerTags(
|
|
204
|
+
project,
|
|
205
|
+
platformId,
|
|
206
|
+
pageToken,
|
|
207
|
+
pageSize,
|
|
208
|
+
search
|
|
209
|
+
);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|Name | Type | Description | Notes|
|
|
215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
216
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
217
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
218
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
219
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
220
|
+
| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
### Return type
|
|
224
|
+
|
|
225
|
+
**InlineObject1**
|
|
226
|
+
|
|
227
|
+
### Authorization
|
|
228
|
+
|
|
229
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
230
|
+
|
|
231
|
+
### HTTP request headers
|
|
232
|
+
|
|
233
|
+
- **Content-Type**: Not defined
|
|
234
|
+
- **Accept**: application/json
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
### HTTP response details
|
|
238
|
+
| Status code | Description | Response headers |
|
|
239
|
+
|-------------|-------------|------------------|
|
|
240
|
+
|**200** | Customer tags response | - |
|
|
241
|
+
|**400** | Failed validation | - |
|
|
242
|
+
|**401** | Not authorised to access this resource | - |
|
|
243
|
+
|**403** | Refuse to authorize | - |
|
|
244
|
+
|**404** | Resource not found | - |
|
|
245
|
+
|**500** | Unknown server error | - |
|
|
246
|
+
|
|
247
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
248
|
+
|
|
174
249
|
# **listCustomers**
|
|
175
250
|
> CustomersResponse listCustomers()
|
|
176
251
|
|
|
@@ -197,6 +272,8 @@ let countries: Array<string>; //Filter customers by country code (optional) (def
|
|
|
197
272
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
198
273
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
199
274
|
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
275
|
+
let demographics: Array<string>; //Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
276
|
+
let tags: Array<string>; //Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
200
277
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
201
278
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
202
279
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -218,6 +295,8 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
218
295
|
projects,
|
|
219
296
|
gender,
|
|
220
297
|
productTypes,
|
|
298
|
+
demographics,
|
|
299
|
+
tags,
|
|
221
300
|
usedDiscount,
|
|
222
301
|
minimumTotalOrderCount,
|
|
223
302
|
maximumTotalOrderCount,
|
|
@@ -244,6 +323,8 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
244
323
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
245
324
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
246
325
|
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
326
|
+
| **demographics** | **Array<string>** | Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
327
|
+
| **tags** | **Array<string>** | Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
247
328
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
248
329
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
249
330
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
package/docs/InlineObject1.md
CHANGED
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**tags** | **Array<string>** | | [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
|
13
14
|
import { InlineObject1 } from '@teemill/platform';
|
|
14
15
|
|
|
15
16
|
const instance: InlineObject1 = {
|
|
16
|
-
|
|
17
|
+
tags,
|
|
18
|
+
nextPageToken,
|
|
17
19
|
};
|
|
18
20
|
```
|
|
19
21
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# InlineObject2
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**redirect_url** | **string** | The URL to redirect to | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { InlineObject2 } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: InlineObject2 = {
|
|
16
|
+
redirect_url,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/PaymentApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
9
9
|
|[**getStripePaymentAccount**](#getstripepaymentaccount) | **GET** /v1/platform/payment/stripe | Get Stripe Payment Account|
|
|
10
10
|
|
|
11
11
|
# **authorizeStripe**
|
|
12
|
-
>
|
|
12
|
+
> InlineObject2 authorizeStripe()
|
|
13
13
|
|
|
14
14
|
Authorize a Stripe payment account
|
|
15
15
|
|
|
@@ -40,7 +40,7 @@ const { status, data } = await apiInstance.authorizeStripe(
|
|
|
40
40
|
|
|
41
41
|
### Return type
|
|
42
42
|
|
|
43
|
-
**
|
|
43
|
+
**InlineObject2**
|
|
44
44
|
|
|
45
45
|
### Authorization
|
|
46
46
|
|