@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/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.55.0
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.55.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -52,10 +52,13 @@ All URIs are relative to *https://localhost:8080*
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
54
54
|
*CustomersApi* | [**createCustomerChatChannel**](docs/CustomersApi.md#createcustomerchatchannel) | **POST** /v1/platform/{platformId}/customers/{customerId}/chat-channel | Create chat channel
|
|
55
|
+
*CustomersApi* | [**createCustomerDataDeletionRequest**](docs/CustomersApi.md#createcustomerdatadeletionrequest) | **POST** /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Create data deletion request
|
|
55
56
|
*CustomersApi* | [**exportCustomers**](docs/CustomersApi.md#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers
|
|
56
57
|
*CustomersApi* | [**getCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer
|
|
58
|
+
*CustomersApi* | [**getCustomerDataDeletionRequest**](docs/CustomersApi.md#getcustomerdatadeletionrequest) | **GET** /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Get data deletion request
|
|
57
59
|
*CustomersApi* | [**listCustomerTags**](docs/CustomersApi.md#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags
|
|
58
60
|
*CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers
|
|
61
|
+
*CustomersApi* | [**updateCustomer**](docs/CustomersApi.md#updatecustomer) | **PATCH** /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID
|
|
59
62
|
*DashboardApi* | [**getDashboard**](docs/DashboardApi.md#getdashboard) | **GET** /v1/platform/{platformId}/dashboard | Get the platform\'s dashboard
|
|
60
63
|
*DashboardApi* | [**saveDashboard**](docs/DashboardApi.md#savedashboard) | **PUT** /v1/platform/{platformId}/dashboard | Save the platform\'s dashboard
|
|
61
64
|
*EnquiriesApi* | [**createCustomerEnquiryChatChannel**](docs/EnquiriesApi.md#createcustomerenquirychatchannel) | **POST** /v1/platform/{platformId}/customers/enquiries/{enquiryId}/chat-channel | Create chat channel
|
|
@@ -139,6 +142,7 @@ Class | Method | HTTP request | Description
|
|
|
139
142
|
- [CustomersResponse](docs/CustomersResponse.md)
|
|
140
143
|
- [CustomsInformation](docs/CustomsInformation.md)
|
|
141
144
|
- [DashboardItem](docs/DashboardItem.md)
|
|
145
|
+
- [DataDeletionRequest](docs/DataDeletionRequest.md)
|
|
142
146
|
- [DeliveryEstimates](docs/DeliveryEstimates.md)
|
|
143
147
|
- [Domain](docs/Domain.md)
|
|
144
148
|
- [Enquiry](docs/Enquiry.md)
|
|
@@ -197,6 +201,7 @@ Class | Method | HTTP request | Description
|
|
|
197
201
|
- [StatusHistoryItem](docs/StatusHistoryItem.md)
|
|
198
202
|
- [Terms](docs/Terms.md)
|
|
199
203
|
- [UpdateCustomerEnquiryRequest](docs/UpdateCustomerEnquiryRequest.md)
|
|
204
|
+
- [UpdateCustomerRequest](docs/UpdateCustomerRequest.md)
|
|
200
205
|
- [UpdateFulfillmentRequest](docs/UpdateFulfillmentRequest.md)
|
|
201
206
|
- [UpdateModerationItemRequest](docs/UpdateModerationItemRequest.md)
|
|
202
207
|
- [UpdateOrderRequest](docs/UpdateOrderRequest.md)
|
package/api.ts
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).
|
|
@@ -344,6 +344,7 @@ export interface Customer {
|
|
|
344
344
|
'country': string | null;
|
|
345
345
|
'statistics': Statistics;
|
|
346
346
|
'shippingAddress'?: Address;
|
|
347
|
+
'billingAddress'?: Address;
|
|
347
348
|
/**
|
|
348
349
|
* Reference to the chat channel resource
|
|
349
350
|
*/
|
|
@@ -389,6 +390,27 @@ export interface DashboardItem {
|
|
|
389
390
|
'sortOrder': number;
|
|
390
391
|
'items'?: Array<DashboardItem> | null;
|
|
391
392
|
}
|
|
393
|
+
/**
|
|
394
|
+
* Data deletion request
|
|
395
|
+
*/
|
|
396
|
+
export interface DataDeletionRequest {
|
|
397
|
+
/**
|
|
398
|
+
* Unique object identifier
|
|
399
|
+
*/
|
|
400
|
+
'id': string;
|
|
401
|
+
/**
|
|
402
|
+
* Reference to the customer resource
|
|
403
|
+
*/
|
|
404
|
+
'customerRef': string;
|
|
405
|
+
/**
|
|
406
|
+
* Reference to the user resource
|
|
407
|
+
*/
|
|
408
|
+
'requestedBy': string;
|
|
409
|
+
/**
|
|
410
|
+
* ISO 8601 Timestamp
|
|
411
|
+
*/
|
|
412
|
+
'requestedAt': string;
|
|
413
|
+
}
|
|
392
414
|
/**
|
|
393
415
|
* Estimated delivery date range. Null if accurate calculation not possible e.g. order contains pre-order items without back in stock dates.
|
|
394
416
|
*/
|
|
@@ -606,7 +628,7 @@ export interface Order {
|
|
|
606
628
|
'contactInformation': ContactInformation;
|
|
607
629
|
'paymentMethod'?: OrderPaymentMethod;
|
|
608
630
|
'shippingAddress': Address;
|
|
609
|
-
'billingAddress'
|
|
631
|
+
'billingAddress': Address;
|
|
610
632
|
/**
|
|
611
633
|
* ISO 8601 Timestamp
|
|
612
634
|
*/
|
|
@@ -1043,6 +1065,12 @@ export interface UpdateCustomerEnquiryRequest {
|
|
|
1043
1065
|
*/
|
|
1044
1066
|
'owner'?: string | null;
|
|
1045
1067
|
}
|
|
1068
|
+
export interface UpdateCustomerRequest {
|
|
1069
|
+
'email'?: string;
|
|
1070
|
+
'name'?: string;
|
|
1071
|
+
'billingAddress'?: Address;
|
|
1072
|
+
'shippingAddress'?: Address;
|
|
1073
|
+
}
|
|
1046
1074
|
export interface UpdateFulfillmentRequest {
|
|
1047
1075
|
/**
|
|
1048
1076
|
* Unique object identifier
|
|
@@ -1063,6 +1091,7 @@ export type UpdateModerationItemRequestJudgementEnum = typeof UpdateModerationIt
|
|
|
1063
1091
|
|
|
1064
1092
|
export interface UpdateOrderRequest {
|
|
1065
1093
|
'email'?: string;
|
|
1094
|
+
'billingAddress'?: Address;
|
|
1066
1095
|
'shippingAddress'?: Address;
|
|
1067
1096
|
'priorityLevel'?: PriorityLevel;
|
|
1068
1097
|
}
|
|
@@ -1165,6 +1194,58 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1165
1194
|
options: localVarRequestOptions,
|
|
1166
1195
|
};
|
|
1167
1196
|
},
|
|
1197
|
+
/**
|
|
1198
|
+
* Create a data deletion request for a customer
|
|
1199
|
+
* @summary Create data deletion request
|
|
1200
|
+
* @param {string} project Project unique identifier
|
|
1201
|
+
* @param {string} platformId The platform identifier
|
|
1202
|
+
* @param {string} customerId The customer identifier
|
|
1203
|
+
* @param {*} [options] Override http request option.
|
|
1204
|
+
* @throws {RequiredError}
|
|
1205
|
+
*/
|
|
1206
|
+
createCustomerDataDeletionRequest: async (project: string, platformId: string, customerId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1207
|
+
// verify required parameter 'project' is not null or undefined
|
|
1208
|
+
assertParamExists('createCustomerDataDeletionRequest', 'project', project)
|
|
1209
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1210
|
+
assertParamExists('createCustomerDataDeletionRequest', 'platformId', platformId)
|
|
1211
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1212
|
+
assertParamExists('createCustomerDataDeletionRequest', 'customerId', customerId)
|
|
1213
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/data-deletion-request`
|
|
1214
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1215
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1216
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1217
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1218
|
+
let baseOptions;
|
|
1219
|
+
if (configuration) {
|
|
1220
|
+
baseOptions = configuration.baseOptions;
|
|
1221
|
+
}
|
|
1222
|
+
|
|
1223
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1224
|
+
const localVarHeaderParameter = {} as any;
|
|
1225
|
+
const localVarQueryParameter = {} as any;
|
|
1226
|
+
|
|
1227
|
+
// authentication session-oauth required
|
|
1228
|
+
// oauth required
|
|
1229
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1230
|
+
|
|
1231
|
+
// authentication api-key required
|
|
1232
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1233
|
+
|
|
1234
|
+
if (project !== undefined) {
|
|
1235
|
+
localVarQueryParameter['project'] = project;
|
|
1236
|
+
}
|
|
1237
|
+
|
|
1238
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1239
|
+
|
|
1240
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1241
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1242
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1243
|
+
|
|
1244
|
+
return {
|
|
1245
|
+
url: toPathString(localVarUrlObj),
|
|
1246
|
+
options: localVarRequestOptions,
|
|
1247
|
+
};
|
|
1248
|
+
},
|
|
1168
1249
|
/**
|
|
1169
1250
|
* Export customers as a CSV file
|
|
1170
1251
|
* @summary Export customers
|
|
@@ -1347,6 +1428,58 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1347
1428
|
options: localVarRequestOptions,
|
|
1348
1429
|
};
|
|
1349
1430
|
},
|
|
1431
|
+
/**
|
|
1432
|
+
* Get a data deletion request for a customer
|
|
1433
|
+
* @summary Get data deletion request
|
|
1434
|
+
* @param {string} project Project unique identifier
|
|
1435
|
+
* @param {string} platformId The platform identifier
|
|
1436
|
+
* @param {string} customerId The customer identifier
|
|
1437
|
+
* @param {*} [options] Override http request option.
|
|
1438
|
+
* @throws {RequiredError}
|
|
1439
|
+
*/
|
|
1440
|
+
getCustomerDataDeletionRequest: async (project: string, platformId: string, customerId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1441
|
+
// verify required parameter 'project' is not null or undefined
|
|
1442
|
+
assertParamExists('getCustomerDataDeletionRequest', 'project', project)
|
|
1443
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1444
|
+
assertParamExists('getCustomerDataDeletionRequest', 'platformId', platformId)
|
|
1445
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1446
|
+
assertParamExists('getCustomerDataDeletionRequest', 'customerId', customerId)
|
|
1447
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/data-deletion-request`
|
|
1448
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1449
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1450
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1451
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1452
|
+
let baseOptions;
|
|
1453
|
+
if (configuration) {
|
|
1454
|
+
baseOptions = configuration.baseOptions;
|
|
1455
|
+
}
|
|
1456
|
+
|
|
1457
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1458
|
+
const localVarHeaderParameter = {} as any;
|
|
1459
|
+
const localVarQueryParameter = {} as any;
|
|
1460
|
+
|
|
1461
|
+
// authentication session-oauth required
|
|
1462
|
+
// oauth required
|
|
1463
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1464
|
+
|
|
1465
|
+
// authentication api-key required
|
|
1466
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1467
|
+
|
|
1468
|
+
if (project !== undefined) {
|
|
1469
|
+
localVarQueryParameter['project'] = project;
|
|
1470
|
+
}
|
|
1471
|
+
|
|
1472
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1473
|
+
|
|
1474
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1475
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1476
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1477
|
+
|
|
1478
|
+
return {
|
|
1479
|
+
url: toPathString(localVarUrlObj),
|
|
1480
|
+
options: localVarRequestOptions,
|
|
1481
|
+
};
|
|
1482
|
+
},
|
|
1350
1483
|
/**
|
|
1351
1484
|
* List customer tags
|
|
1352
1485
|
* @summary List customer tags
|
|
@@ -1550,6 +1683,61 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1550
1683
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1551
1684
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1552
1685
|
|
|
1686
|
+
return {
|
|
1687
|
+
url: toPathString(localVarUrlObj),
|
|
1688
|
+
options: localVarRequestOptions,
|
|
1689
|
+
};
|
|
1690
|
+
},
|
|
1691
|
+
/**
|
|
1692
|
+
*
|
|
1693
|
+
* @summary Update the customer with the given customer ID
|
|
1694
|
+
* @param {string} project Project unique identifier
|
|
1695
|
+
* @param {string} platformId The platform identifier
|
|
1696
|
+
* @param {string} customerId The customer identifier
|
|
1697
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1698
|
+
* @param {*} [options] Override http request option.
|
|
1699
|
+
* @throws {RequiredError}
|
|
1700
|
+
*/
|
|
1701
|
+
updateCustomer: async (project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1702
|
+
// verify required parameter 'project' is not null or undefined
|
|
1703
|
+
assertParamExists('updateCustomer', 'project', project)
|
|
1704
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1705
|
+
assertParamExists('updateCustomer', 'platformId', platformId)
|
|
1706
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1707
|
+
assertParamExists('updateCustomer', 'customerId', customerId)
|
|
1708
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
1709
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1710
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1711
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1712
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1713
|
+
let baseOptions;
|
|
1714
|
+
if (configuration) {
|
|
1715
|
+
baseOptions = configuration.baseOptions;
|
|
1716
|
+
}
|
|
1717
|
+
|
|
1718
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
1719
|
+
const localVarHeaderParameter = {} as any;
|
|
1720
|
+
const localVarQueryParameter = {} as any;
|
|
1721
|
+
|
|
1722
|
+
// authentication session-oauth required
|
|
1723
|
+
// oauth required
|
|
1724
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1725
|
+
|
|
1726
|
+
// authentication api-key required
|
|
1727
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1728
|
+
|
|
1729
|
+
if (project !== undefined) {
|
|
1730
|
+
localVarQueryParameter['project'] = project;
|
|
1731
|
+
}
|
|
1732
|
+
|
|
1733
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1734
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1735
|
+
|
|
1736
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1737
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1738
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1739
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateCustomerRequest, localVarRequestOptions, configuration)
|
|
1740
|
+
|
|
1553
1741
|
return {
|
|
1554
1742
|
url: toPathString(localVarUrlObj),
|
|
1555
1743
|
options: localVarRequestOptions,
|
|
@@ -1579,6 +1767,21 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1579
1767
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.createCustomerChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
1580
1768
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1581
1769
|
},
|
|
1770
|
+
/**
|
|
1771
|
+
* Create a data deletion request for a customer
|
|
1772
|
+
* @summary Create data deletion request
|
|
1773
|
+
* @param {string} project Project unique identifier
|
|
1774
|
+
* @param {string} platformId The platform identifier
|
|
1775
|
+
* @param {string} customerId The customer identifier
|
|
1776
|
+
* @param {*} [options] Override http request option.
|
|
1777
|
+
* @throws {RequiredError}
|
|
1778
|
+
*/
|
|
1779
|
+
async createCustomerDataDeletionRequest(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataDeletionRequest>> {
|
|
1780
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createCustomerDataDeletionRequest(project, platformId, customerId, options);
|
|
1781
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1782
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.createCustomerDataDeletionRequest']?.[localVarOperationServerIndex]?.url;
|
|
1783
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1784
|
+
},
|
|
1582
1785
|
/**
|
|
1583
1786
|
* Export customers as a CSV file
|
|
1584
1787
|
* @summary Export customers
|
|
@@ -1624,6 +1827,21 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1624
1827
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.getCustomer']?.[localVarOperationServerIndex]?.url;
|
|
1625
1828
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1626
1829
|
},
|
|
1830
|
+
/**
|
|
1831
|
+
* Get a data deletion request for a customer
|
|
1832
|
+
* @summary Get data deletion request
|
|
1833
|
+
* @param {string} project Project unique identifier
|
|
1834
|
+
* @param {string} platformId The platform identifier
|
|
1835
|
+
* @param {string} customerId The customer identifier
|
|
1836
|
+
* @param {*} [options] Override http request option.
|
|
1837
|
+
* @throws {RequiredError}
|
|
1838
|
+
*/
|
|
1839
|
+
async getCustomerDataDeletionRequest(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataDeletionRequest>> {
|
|
1840
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomerDataDeletionRequest(project, platformId, customerId, options);
|
|
1841
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1842
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.getCustomerDataDeletionRequest']?.[localVarOperationServerIndex]?.url;
|
|
1843
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1844
|
+
},
|
|
1627
1845
|
/**
|
|
1628
1846
|
* List customer tags
|
|
1629
1847
|
* @summary List customer tags
|
|
@@ -1674,6 +1892,22 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1674
1892
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1675
1893
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1676
1894
|
},
|
|
1895
|
+
/**
|
|
1896
|
+
*
|
|
1897
|
+
* @summary Update the customer with the given customer ID
|
|
1898
|
+
* @param {string} project Project unique identifier
|
|
1899
|
+
* @param {string} platformId The platform identifier
|
|
1900
|
+
* @param {string} customerId The customer identifier
|
|
1901
|
+
* @param {UpdateCustomerRequest} [updateCustomerRequest]
|
|
1902
|
+
* @param {*} [options] Override http request option.
|
|
1903
|
+
* @throws {RequiredError}
|
|
1904
|
+
*/
|
|
1905
|
+
async updateCustomer(project: string, platformId: string, customerId: string, updateCustomerRequest?: UpdateCustomerRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>> {
|
|
1906
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateCustomer(project, platformId, customerId, updateCustomerRequest, options);
|
|
1907
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1908
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.updateCustomer']?.[localVarOperationServerIndex]?.url;
|
|
1909
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1910
|
+
},
|
|
1677
1911
|
}
|
|
1678
1912
|
};
|
|
1679
1913
|
|
|
@@ -1693,6 +1927,16 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1693
1927
|
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
1694
1928
|
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1695
1929
|
},
|
|
1930
|
+
/**
|
|
1931
|
+
* Create a data deletion request for a customer
|
|
1932
|
+
* @summary Create data deletion request
|
|
1933
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
1934
|
+
* @param {*} [options] Override http request option.
|
|
1935
|
+
* @throws {RequiredError}
|
|
1936
|
+
*/
|
|
1937
|
+
createCustomerDataDeletionRequest(requestParameters: CustomersApiCreateCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataDeletionRequest> {
|
|
1938
|
+
return localVarFp.createCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1939
|
+
},
|
|
1696
1940
|
/**
|
|
1697
1941
|
* Export customers as a CSV file
|
|
1698
1942
|
* @summary Export customers
|
|
@@ -1713,6 +1957,16 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1713
1957
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
1714
1958
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1715
1959
|
},
|
|
1960
|
+
/**
|
|
1961
|
+
* Get a data deletion request for a customer
|
|
1962
|
+
* @summary Get data deletion request
|
|
1963
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
1964
|
+
* @param {*} [options] Override http request option.
|
|
1965
|
+
* @throws {RequiredError}
|
|
1966
|
+
*/
|
|
1967
|
+
getCustomerDataDeletionRequest(requestParameters: CustomersApiGetCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataDeletionRequest> {
|
|
1968
|
+
return localVarFp.getCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1969
|
+
},
|
|
1716
1970
|
/**
|
|
1717
1971
|
* List customer tags
|
|
1718
1972
|
* @summary List customer tags
|
|
@@ -1733,6 +1987,16 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1733
1987
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
1734
1988
|
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));
|
|
1735
1989
|
},
|
|
1990
|
+
/**
|
|
1991
|
+
*
|
|
1992
|
+
* @summary Update the customer with the given customer ID
|
|
1993
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
1994
|
+
* @param {*} [options] Override http request option.
|
|
1995
|
+
* @throws {RequiredError}
|
|
1996
|
+
*/
|
|
1997
|
+
updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
1998
|
+
return localVarFp.updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(axios, basePath));
|
|
1999
|
+
},
|
|
1736
2000
|
};
|
|
1737
2001
|
};
|
|
1738
2002
|
|
|
@@ -1756,6 +2020,26 @@ export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
|
1756
2020
|
readonly customerId: string
|
|
1757
2021
|
}
|
|
1758
2022
|
|
|
2023
|
+
/**
|
|
2024
|
+
* Request parameters for createCustomerDataDeletionRequest operation in CustomersApi.
|
|
2025
|
+
*/
|
|
2026
|
+
export interface CustomersApiCreateCustomerDataDeletionRequestRequest {
|
|
2027
|
+
/**
|
|
2028
|
+
* Project unique identifier
|
|
2029
|
+
*/
|
|
2030
|
+
readonly project: string
|
|
2031
|
+
|
|
2032
|
+
/**
|
|
2033
|
+
* The platform identifier
|
|
2034
|
+
*/
|
|
2035
|
+
readonly platformId: string
|
|
2036
|
+
|
|
2037
|
+
/**
|
|
2038
|
+
* The customer identifier
|
|
2039
|
+
*/
|
|
2040
|
+
readonly customerId: string
|
|
2041
|
+
}
|
|
2042
|
+
|
|
1759
2043
|
/**
|
|
1760
2044
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1761
2045
|
*/
|
|
@@ -1871,6 +2155,26 @@ export interface CustomersApiGetCustomerRequest {
|
|
|
1871
2155
|
readonly customerId: string
|
|
1872
2156
|
}
|
|
1873
2157
|
|
|
2158
|
+
/**
|
|
2159
|
+
* Request parameters for getCustomerDataDeletionRequest operation in CustomersApi.
|
|
2160
|
+
*/
|
|
2161
|
+
export interface CustomersApiGetCustomerDataDeletionRequestRequest {
|
|
2162
|
+
/**
|
|
2163
|
+
* Project unique identifier
|
|
2164
|
+
*/
|
|
2165
|
+
readonly project: string
|
|
2166
|
+
|
|
2167
|
+
/**
|
|
2168
|
+
* The platform identifier
|
|
2169
|
+
*/
|
|
2170
|
+
readonly platformId: string
|
|
2171
|
+
|
|
2172
|
+
/**
|
|
2173
|
+
* The customer identifier
|
|
2174
|
+
*/
|
|
2175
|
+
readonly customerId: string
|
|
2176
|
+
}
|
|
2177
|
+
|
|
1874
2178
|
/**
|
|
1875
2179
|
* Request parameters for listCustomerTags operation in CustomersApi.
|
|
1876
2180
|
*/
|
|
@@ -2011,6 +2315,28 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2011
2315
|
readonly lastPurchasedEnd?: string
|
|
2012
2316
|
}
|
|
2013
2317
|
|
|
2318
|
+
/**
|
|
2319
|
+
* Request parameters for updateCustomer operation in CustomersApi.
|
|
2320
|
+
*/
|
|
2321
|
+
export interface CustomersApiUpdateCustomerRequest {
|
|
2322
|
+
/**
|
|
2323
|
+
* Project unique identifier
|
|
2324
|
+
*/
|
|
2325
|
+
readonly project: string
|
|
2326
|
+
|
|
2327
|
+
/**
|
|
2328
|
+
* The platform identifier
|
|
2329
|
+
*/
|
|
2330
|
+
readonly platformId: string
|
|
2331
|
+
|
|
2332
|
+
/**
|
|
2333
|
+
* The customer identifier
|
|
2334
|
+
*/
|
|
2335
|
+
readonly customerId: string
|
|
2336
|
+
|
|
2337
|
+
readonly updateCustomerRequest?: UpdateCustomerRequest
|
|
2338
|
+
}
|
|
2339
|
+
|
|
2014
2340
|
/**
|
|
2015
2341
|
* CustomersApi - object-oriented interface
|
|
2016
2342
|
*/
|
|
@@ -2026,6 +2352,17 @@ export class CustomersApi extends BaseAPI {
|
|
|
2026
2352
|
return CustomersApiFp(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2027
2353
|
}
|
|
2028
2354
|
|
|
2355
|
+
/**
|
|
2356
|
+
* Create a data deletion request for a customer
|
|
2357
|
+
* @summary Create data deletion request
|
|
2358
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
2359
|
+
* @param {*} [options] Override http request option.
|
|
2360
|
+
* @throws {RequiredError}
|
|
2361
|
+
*/
|
|
2362
|
+
public createCustomerDataDeletionRequest(requestParameters: CustomersApiCreateCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig) {
|
|
2363
|
+
return CustomersApiFp(this.configuration).createCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2364
|
+
}
|
|
2365
|
+
|
|
2029
2366
|
/**
|
|
2030
2367
|
* Export customers as a CSV file
|
|
2031
2368
|
* @summary Export customers
|
|
@@ -2048,6 +2385,17 @@ export class CustomersApi extends BaseAPI {
|
|
|
2048
2385
|
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2049
2386
|
}
|
|
2050
2387
|
|
|
2388
|
+
/**
|
|
2389
|
+
* Get a data deletion request for a customer
|
|
2390
|
+
* @summary Get data deletion request
|
|
2391
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
2392
|
+
* @param {*} [options] Override http request option.
|
|
2393
|
+
* @throws {RequiredError}
|
|
2394
|
+
*/
|
|
2395
|
+
public getCustomerDataDeletionRequest(requestParameters: CustomersApiGetCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig) {
|
|
2396
|
+
return CustomersApiFp(this.configuration).getCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2397
|
+
}
|
|
2398
|
+
|
|
2051
2399
|
/**
|
|
2052
2400
|
* List customer tags
|
|
2053
2401
|
* @summary List customer tags
|
|
@@ -2069,6 +2417,17 @@ export class CustomersApi extends BaseAPI {
|
|
|
2069
2417
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2070
2418
|
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));
|
|
2071
2419
|
}
|
|
2420
|
+
|
|
2421
|
+
/**
|
|
2422
|
+
*
|
|
2423
|
+
* @summary Update the customer with the given customer ID
|
|
2424
|
+
* @param {CustomersApiUpdateCustomerRequest} requestParameters Request parameters.
|
|
2425
|
+
* @param {*} [options] Override http request option.
|
|
2426
|
+
* @throws {RequiredError}
|
|
2427
|
+
*/
|
|
2428
|
+
public updateCustomer(requestParameters: CustomersApiUpdateCustomerRequest, options?: RawAxiosRequestConfig) {
|
|
2429
|
+
return CustomersApiFp(this.configuration).updateCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, requestParameters.updateCustomerRequest, options).then((request) => request(this.axios, this.basePath));
|
|
2430
|
+
}
|
|
2072
2431
|
}
|
|
2073
2432
|
|
|
2074
2433
|
export const ExportCustomersSortByEnum = {
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED