@teemill/platform 0.53.0 → 0.55.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 +7 -2
- package/api.ts +361 -2
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +193 -2
- package/dist/api.js +254 -1
- 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 +193 -2
- package/dist/esm/api.js +254 -1
- 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/Customer.md +2 -0
- package/docs/CustomersApi.md +190 -0
- package/docs/DataDeletionRequest.md +27 -0
- package/docs/Order.md +1 -1
- package/docs/UpdateCustomerRequest.md +26 -0
- package/docs/UpdateOrderRequest.md +2 -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.55.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -135,6 +135,51 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
135
135
|
options: localVarRequestOptions,
|
|
136
136
|
};
|
|
137
137
|
}),
|
|
138
|
+
/**
|
|
139
|
+
* Create a data deletion request for a customer
|
|
140
|
+
* @summary Create data deletion request
|
|
141
|
+
* @param {string} project Project unique identifier
|
|
142
|
+
* @param {string} platformId The platform identifier
|
|
143
|
+
* @param {string} customerId The customer identifier
|
|
144
|
+
* @param {*} [options] Override http request option.
|
|
145
|
+
* @throws {RequiredError}
|
|
146
|
+
*/
|
|
147
|
+
createCustomerDataDeletionRequest: (project_1, platformId_1, customerId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, ...args_1], void 0, function* (project, platformId, customerId, options = {}) {
|
|
148
|
+
// verify required parameter 'project' is not null or undefined
|
|
149
|
+
assertParamExists('createCustomerDataDeletionRequest', 'project', project);
|
|
150
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
151
|
+
assertParamExists('createCustomerDataDeletionRequest', 'platformId', platformId);
|
|
152
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
153
|
+
assertParamExists('createCustomerDataDeletionRequest', 'customerId', customerId);
|
|
154
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/data-deletion-request`
|
|
155
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
156
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
157
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
158
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
159
|
+
let baseOptions;
|
|
160
|
+
if (configuration) {
|
|
161
|
+
baseOptions = configuration.baseOptions;
|
|
162
|
+
}
|
|
163
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
164
|
+
const localVarHeaderParameter = {};
|
|
165
|
+
const localVarQueryParameter = {};
|
|
166
|
+
// authentication session-oauth required
|
|
167
|
+
// oauth required
|
|
168
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
169
|
+
// authentication api-key required
|
|
170
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
171
|
+
if (project !== undefined) {
|
|
172
|
+
localVarQueryParameter['project'] = project;
|
|
173
|
+
}
|
|
174
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
175
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
176
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
177
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
178
|
+
return {
|
|
179
|
+
url: toPathString(localVarUrlObj),
|
|
180
|
+
options: localVarRequestOptions,
|
|
181
|
+
};
|
|
182
|
+
}),
|
|
138
183
|
/**
|
|
139
184
|
* Export customers as a CSV file
|
|
140
185
|
* @summary Export customers
|
|
@@ -287,6 +332,51 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
287
332
|
options: localVarRequestOptions,
|
|
288
333
|
};
|
|
289
334
|
}),
|
|
335
|
+
/**
|
|
336
|
+
* Get a data deletion request for a customer
|
|
337
|
+
* @summary Get data deletion request
|
|
338
|
+
* @param {string} project Project unique identifier
|
|
339
|
+
* @param {string} platformId The platform identifier
|
|
340
|
+
* @param {string} customerId The customer identifier
|
|
341
|
+
* @param {*} [options] Override http request option.
|
|
342
|
+
* @throws {RequiredError}
|
|
343
|
+
*/
|
|
344
|
+
getCustomerDataDeletionRequest: (project_1, platformId_1, customerId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, ...args_1], void 0, function* (project, platformId, customerId, options = {}) {
|
|
345
|
+
// verify required parameter 'project' is not null or undefined
|
|
346
|
+
assertParamExists('getCustomerDataDeletionRequest', 'project', project);
|
|
347
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
348
|
+
assertParamExists('getCustomerDataDeletionRequest', 'platformId', platformId);
|
|
349
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
350
|
+
assertParamExists('getCustomerDataDeletionRequest', 'customerId', customerId);
|
|
351
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/data-deletion-request`
|
|
352
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
353
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
354
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
355
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
356
|
+
let baseOptions;
|
|
357
|
+
if (configuration) {
|
|
358
|
+
baseOptions = configuration.baseOptions;
|
|
359
|
+
}
|
|
360
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
361
|
+
const localVarHeaderParameter = {};
|
|
362
|
+
const localVarQueryParameter = {};
|
|
363
|
+
// authentication session-oauth required
|
|
364
|
+
// oauth required
|
|
365
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
366
|
+
// authentication api-key required
|
|
367
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
368
|
+
if (project !== undefined) {
|
|
369
|
+
localVarQueryParameter['project'] = project;
|
|
370
|
+
}
|
|
371
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
372
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
373
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
374
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
375
|
+
return {
|
|
376
|
+
url: toPathString(localVarUrlObj),
|
|
377
|
+
options: localVarRequestOptions,
|
|
378
|
+
};
|
|
379
|
+
}),
|
|
290
380
|
/**
|
|
291
381
|
* List customer tags
|
|
292
382
|
* @summary List customer tags
|
|
@@ -459,6 +549,54 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
459
549
|
options: localVarRequestOptions,
|
|
460
550
|
};
|
|
461
551
|
}),
|
|
552
|
+
/**
|
|
553
|
+
*
|
|
554
|
+
* @summary Update the customer with the given customer ID
|
|
555
|
+
* @param {string} project Project unique identifier
|
|
556
|
+
* @param {string} platformId The platform identifier
|
|
557
|
+
* @param {string} customerId The customer identifier
|
|
558
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
559
|
+
* @param {*} [options] Override http request option.
|
|
560
|
+
* @throws {RequiredError}
|
|
561
|
+
*/
|
|
562
|
+
updateCustomer: (project_1, platformId_1, customerId_1, updateCustomerRequest_1, ...args_1) => __awaiter(this, [project_1, platformId_1, customerId_1, updateCustomerRequest_1, ...args_1], void 0, function* (project, platformId, customerId, updateCustomerRequest, options = {}) {
|
|
563
|
+
// verify required parameter 'project' is not null or undefined
|
|
564
|
+
assertParamExists('updateCustomer', 'project', project);
|
|
565
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
566
|
+
assertParamExists('updateCustomer', 'platformId', platformId);
|
|
567
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
568
|
+
assertParamExists('updateCustomer', 'customerId', customerId);
|
|
569
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
570
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
571
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
572
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
573
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
574
|
+
let baseOptions;
|
|
575
|
+
if (configuration) {
|
|
576
|
+
baseOptions = configuration.baseOptions;
|
|
577
|
+
}
|
|
578
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
|
|
579
|
+
const localVarHeaderParameter = {};
|
|
580
|
+
const localVarQueryParameter = {};
|
|
581
|
+
// authentication session-oauth required
|
|
582
|
+
// oauth required
|
|
583
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
584
|
+
// authentication api-key required
|
|
585
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
586
|
+
if (project !== undefined) {
|
|
587
|
+
localVarQueryParameter['project'] = project;
|
|
588
|
+
}
|
|
589
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
590
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
591
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
592
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
593
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
594
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerRequest, localVarRequestOptions, configuration);
|
|
595
|
+
return {
|
|
596
|
+
url: toPathString(localVarUrlObj),
|
|
597
|
+
options: localVarRequestOptions,
|
|
598
|
+
};
|
|
599
|
+
}),
|
|
462
600
|
};
|
|
463
601
|
};
|
|
464
602
|
/**
|
|
@@ -485,6 +623,24 @@ export const CustomersApiFp = function (configuration) {
|
|
|
485
623
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
486
624
|
});
|
|
487
625
|
},
|
|
626
|
+
/**
|
|
627
|
+
* Create a data deletion request for a customer
|
|
628
|
+
* @summary Create data deletion request
|
|
629
|
+
* @param {string} project Project unique identifier
|
|
630
|
+
* @param {string} platformId The platform identifier
|
|
631
|
+
* @param {string} customerId The customer identifier
|
|
632
|
+
* @param {*} [options] Override http request option.
|
|
633
|
+
* @throws {RequiredError}
|
|
634
|
+
*/
|
|
635
|
+
createCustomerDataDeletionRequest(project, platformId, customerId, options) {
|
|
636
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
637
|
+
var _a, _b, _c;
|
|
638
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createCustomerDataDeletionRequest(project, platformId, customerId, options);
|
|
639
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
640
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.createCustomerDataDeletionRequest']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
641
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
642
|
+
});
|
|
643
|
+
},
|
|
488
644
|
/**
|
|
489
645
|
* Export customers as a CSV file
|
|
490
646
|
* @summary Export customers
|
|
@@ -536,6 +692,24 @@ export const CustomersApiFp = function (configuration) {
|
|
|
536
692
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
537
693
|
});
|
|
538
694
|
},
|
|
695
|
+
/**
|
|
696
|
+
* Get a data deletion request for a customer
|
|
697
|
+
* @summary Get data deletion request
|
|
698
|
+
* @param {string} project Project unique identifier
|
|
699
|
+
* @param {string} platformId The platform identifier
|
|
700
|
+
* @param {string} customerId The customer identifier
|
|
701
|
+
* @param {*} [options] Override http request option.
|
|
702
|
+
* @throws {RequiredError}
|
|
703
|
+
*/
|
|
704
|
+
getCustomerDataDeletionRequest(project, platformId, customerId, options) {
|
|
705
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
706
|
+
var _a, _b, _c;
|
|
707
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomerDataDeletionRequest(project, platformId, customerId, options);
|
|
708
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
709
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.getCustomerDataDeletionRequest']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
710
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
711
|
+
});
|
|
712
|
+
},
|
|
539
713
|
/**
|
|
540
714
|
* List customer tags
|
|
541
715
|
* @summary List customer tags
|
|
@@ -592,6 +766,25 @@ export const CustomersApiFp = function (configuration) {
|
|
|
592
766
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
593
767
|
});
|
|
594
768
|
},
|
|
769
|
+
/**
|
|
770
|
+
*
|
|
771
|
+
* @summary Update the customer with the given customer ID
|
|
772
|
+
* @param {string} project Project unique identifier
|
|
773
|
+
* @param {string} platformId The platform identifier
|
|
774
|
+
* @param {string} customerId The customer identifier
|
|
775
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
776
|
+
* @param {*} [options] Override http request option.
|
|
777
|
+
* @throws {RequiredError}
|
|
778
|
+
*/
|
|
779
|
+
updateCustomer(project, platformId, customerId, updateCustomerRequest, options) {
|
|
780
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
781
|
+
var _a, _b, _c;
|
|
782
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.updateCustomer(project, platformId, customerId, updateCustomerRequest, options);
|
|
783
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
784
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.updateCustomer']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
785
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
786
|
+
});
|
|
787
|
+
},
|
|
595
788
|
};
|
|
596
789
|
};
|
|
597
790
|
/**
|
|
@@ -610,6 +803,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
610
803
|
createCustomerChatChannel(requestParameters, options) {
|
|
611
804
|
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
612
805
|
},
|
|
806
|
+
/**
|
|
807
|
+
* Create a data deletion request for a customer
|
|
808
|
+
* @summary Create data deletion request
|
|
809
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
810
|
+
* @param {*} [options] Override http request option.
|
|
811
|
+
* @throws {RequiredError}
|
|
812
|
+
*/
|
|
813
|
+
createCustomerDataDeletionRequest(requestParameters, options) {
|
|
814
|
+
return localVarFp.createCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
815
|
+
},
|
|
613
816
|
/**
|
|
614
817
|
* Export customers as a CSV file
|
|
615
818
|
* @summary Export customers
|
|
@@ -630,6 +833,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
630
833
|
getCustomer(requestParameters, options) {
|
|
631
834
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
632
835
|
},
|
|
836
|
+
/**
|
|
837
|
+
* Get a data deletion request for a customer
|
|
838
|
+
* @summary Get data deletion request
|
|
839
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
840
|
+
* @param {*} [options] Override http request option.
|
|
841
|
+
* @throws {RequiredError}
|
|
842
|
+
*/
|
|
843
|
+
getCustomerDataDeletionRequest(requestParameters, options) {
|
|
844
|
+
return localVarFp.getCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
845
|
+
},
|
|
633
846
|
/**
|
|
634
847
|
* List customer tags
|
|
635
848
|
* @summary List customer tags
|
|
@@ -650,6 +863,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
650
863
|
listCustomers(requestParameters, options) {
|
|
651
864
|
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));
|
|
652
865
|
},
|
|
866
|
+
/**
|
|
867
|
+
*
|
|
868
|
+
* @summary Update the customer with the given customer ID
|
|
869
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
870
|
+
* @param {*} [options] Override http request option.
|
|
871
|
+
* @throws {RequiredError}
|
|
872
|
+
*/
|
|
873
|
+
updateCustomer(requestParameters, options) {
|
|
874
|
+
return localVarFp.updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(axios, basePath));
|
|
875
|
+
},
|
|
653
876
|
};
|
|
654
877
|
};
|
|
655
878
|
/**
|
|
@@ -666,6 +889,16 @@ export class CustomersApi extends BaseAPI {
|
|
|
666
889
|
createCustomerChatChannel(requestParameters, options) {
|
|
667
890
|
return CustomersApiFp(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
668
891
|
}
|
|
892
|
+
/**
|
|
893
|
+
* Create a data deletion request for a customer
|
|
894
|
+
* @summary Create data deletion request
|
|
895
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
896
|
+
* @param {*} [options] Override http request option.
|
|
897
|
+
* @throws {RequiredError}
|
|
898
|
+
*/
|
|
899
|
+
createCustomerDataDeletionRequest(requestParameters, options) {
|
|
900
|
+
return CustomersApiFp(this.configuration).createCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
901
|
+
}
|
|
669
902
|
/**
|
|
670
903
|
* Export customers as a CSV file
|
|
671
904
|
* @summary Export customers
|
|
@@ -686,6 +919,16 @@ export class CustomersApi extends BaseAPI {
|
|
|
686
919
|
getCustomer(requestParameters, options) {
|
|
687
920
|
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
688
921
|
}
|
|
922
|
+
/**
|
|
923
|
+
* Get a data deletion request for a customer
|
|
924
|
+
* @summary Get data deletion request
|
|
925
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
926
|
+
* @param {*} [options] Override http request option.
|
|
927
|
+
* @throws {RequiredError}
|
|
928
|
+
*/
|
|
929
|
+
getCustomerDataDeletionRequest(requestParameters, options) {
|
|
930
|
+
return CustomersApiFp(this.configuration).getCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
931
|
+
}
|
|
689
932
|
/**
|
|
690
933
|
* List customer tags
|
|
691
934
|
* @summary List customer tags
|
|
@@ -706,6 +949,16 @@ export class CustomersApi extends BaseAPI {
|
|
|
706
949
|
listCustomers(requestParameters, options) {
|
|
707
950
|
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));
|
|
708
951
|
}
|
|
952
|
+
/**
|
|
953
|
+
*
|
|
954
|
+
* @summary Update the customer with the given customer ID
|
|
955
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
956
|
+
* @param {*} [options] Override http request option.
|
|
957
|
+
* @throws {RequiredError}
|
|
958
|
+
*/
|
|
959
|
+
updateCustomer(requestParameters, options) {
|
|
960
|
+
return CustomersApiFp(this.configuration).updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
961
|
+
}
|
|
709
962
|
}
|
|
710
963
|
export const ExportCustomersSortByEnum = {
|
|
711
964
|
LifetimeValue: '+lifetimeValue',
|
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
package/docs/Customer.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**country** | **string** | | [default to undefined]
|
|
15
15
|
**statistics** | [**Statistics**](Statistics.md) | | [default to undefined]
|
|
16
16
|
**shippingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
17
|
+
**billingAddress** | [**Address**](Address.md) | | [optional] [default to undefined]
|
|
17
18
|
**chatChannelRef** | **string** | Reference to the chat channel resource | [optional] [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
@@ -30,6 +31,7 @@ const instance: Customer = {
|
|
|
30
31
|
country,
|
|
31
32
|
statistics,
|
|
32
33
|
shippingAddress,
|
|
34
|
+
billingAddress,
|
|
33
35
|
chatChannelRef,
|
|
34
36
|
};
|
|
35
37
|
```
|