@teemill/platform 0.54.0 → 0.55.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 +5 -2
- package/api.ts +238 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +128 -1
- package/dist/api.js +167 -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 +128 -1
- package/dist/esm/api.js +167 -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/CustomersApi.md +124 -0
- package/docs/DataDeletionRequest.md +27 -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.1
|
|
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.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -52,8 +52,10 @@ 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
|
|
59
61
|
*CustomersApi* | [**updateCustomer**](docs/CustomersApi.md#updatecustomer) | **PATCH** /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID
|
|
@@ -140,6 +142,7 @@ Class | Method | HTTP request | Description
|
|
|
140
142
|
- [CustomersResponse](docs/CustomersResponse.md)
|
|
141
143
|
- [CustomsInformation](docs/CustomsInformation.md)
|
|
142
144
|
- [DashboardItem](docs/DashboardItem.md)
|
|
145
|
+
- [DataDeletionRequest](docs/DataDeletionRequest.md)
|
|
143
146
|
- [DeliveryEstimates](docs/DeliveryEstimates.md)
|
|
144
147
|
- [Domain](docs/Domain.md)
|
|
145
148
|
- [Enquiry](docs/Enquiry.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.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -390,6 +390,27 @@ export interface DashboardItem {
|
|
|
390
390
|
'sortOrder': number;
|
|
391
391
|
'items'?: Array<DashboardItem> | null;
|
|
392
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
|
+
'requestedByRef': string;
|
|
409
|
+
/**
|
|
410
|
+
* ISO 8601 Timestamp
|
|
411
|
+
*/
|
|
412
|
+
'requestedAt': string;
|
|
413
|
+
}
|
|
393
414
|
/**
|
|
394
415
|
* Estimated delivery date range. Null if accurate calculation not possible e.g. order contains pre-order items without back in stock dates.
|
|
395
416
|
*/
|
|
@@ -1173,6 +1194,58 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1173
1194
|
options: localVarRequestOptions,
|
|
1174
1195
|
};
|
|
1175
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
|
+
},
|
|
1176
1249
|
/**
|
|
1177
1250
|
* Export customers as a CSV file
|
|
1178
1251
|
* @summary Export customers
|
|
@@ -1355,6 +1428,58 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1355
1428
|
options: localVarRequestOptions,
|
|
1356
1429
|
};
|
|
1357
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
|
+
},
|
|
1358
1483
|
/**
|
|
1359
1484
|
* List customer tags
|
|
1360
1485
|
* @summary List customer tags
|
|
@@ -1642,6 +1767,21 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1642
1767
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.createCustomerChatChannel']?.[localVarOperationServerIndex]?.url;
|
|
1643
1768
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1644
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
|
+
},
|
|
1645
1785
|
/**
|
|
1646
1786
|
* Export customers as a CSV file
|
|
1647
1787
|
* @summary Export customers
|
|
@@ -1687,6 +1827,21 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1687
1827
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.getCustomer']?.[localVarOperationServerIndex]?.url;
|
|
1688
1828
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1689
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
|
+
},
|
|
1690
1845
|
/**
|
|
1691
1846
|
* List customer tags
|
|
1692
1847
|
* @summary List customer tags
|
|
@@ -1772,6 +1927,16 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1772
1927
|
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response> {
|
|
1773
1928
|
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1774
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
|
+
},
|
|
1775
1940
|
/**
|
|
1776
1941
|
* Export customers as a CSV file
|
|
1777
1942
|
* @summary Export customers
|
|
@@ -1792,6 +1957,16 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1792
1957
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
1793
1958
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1794
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
|
+
},
|
|
1795
1970
|
/**
|
|
1796
1971
|
* List customer tags
|
|
1797
1972
|
* @summary List customer tags
|
|
@@ -1845,6 +2020,26 @@ export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
|
1845
2020
|
readonly customerId: string
|
|
1846
2021
|
}
|
|
1847
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
|
+
|
|
1848
2043
|
/**
|
|
1849
2044
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1850
2045
|
*/
|
|
@@ -1960,6 +2155,26 @@ export interface CustomersApiGetCustomerRequest {
|
|
|
1960
2155
|
readonly customerId: string
|
|
1961
2156
|
}
|
|
1962
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
|
+
|
|
1963
2178
|
/**
|
|
1964
2179
|
* Request parameters for listCustomerTags operation in CustomersApi.
|
|
1965
2180
|
*/
|
|
@@ -2137,6 +2352,17 @@ export class CustomersApi extends BaseAPI {
|
|
|
2137
2352
|
return CustomersApiFp(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2138
2353
|
}
|
|
2139
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
|
+
|
|
2140
2366
|
/**
|
|
2141
2367
|
* Export customers as a CSV file
|
|
2142
2368
|
* @summary Export customers
|
|
@@ -2159,6 +2385,17 @@ export class CustomersApi extends BaseAPI {
|
|
|
2159
2385
|
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2160
2386
|
}
|
|
2161
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
|
+
|
|
2162
2399
|
/**
|
|
2163
2400
|
* List customer tags
|
|
2164
2401
|
* @summary List customer tags
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Platform API
|
|
3
3
|
* Manage Your podOS platform
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 0.
|
|
5
|
+
* The version of the OpenAPI document: 0.55.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -365,6 +365,27 @@ export interface DashboardItem {
|
|
|
365
365
|
'sortOrder': number;
|
|
366
366
|
'items'?: Array<DashboardItem> | null;
|
|
367
367
|
}
|
|
368
|
+
/**
|
|
369
|
+
* Data deletion request
|
|
370
|
+
*/
|
|
371
|
+
export interface DataDeletionRequest {
|
|
372
|
+
/**
|
|
373
|
+
* Unique object identifier
|
|
374
|
+
*/
|
|
375
|
+
'id': string;
|
|
376
|
+
/**
|
|
377
|
+
* Reference to the customer resource
|
|
378
|
+
*/
|
|
379
|
+
'customerRef': string;
|
|
380
|
+
/**
|
|
381
|
+
* Reference to the user resource
|
|
382
|
+
*/
|
|
383
|
+
'requestedByRef': string;
|
|
384
|
+
/**
|
|
385
|
+
* ISO 8601 Timestamp
|
|
386
|
+
*/
|
|
387
|
+
'requestedAt': string;
|
|
388
|
+
}
|
|
368
389
|
/**
|
|
369
390
|
* Estimated delivery date range. Null if accurate calculation not possible e.g. order contains pre-order items without back in stock dates.
|
|
370
391
|
*/
|
|
@@ -1075,6 +1096,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1075
1096
|
* @throws {RequiredError}
|
|
1076
1097
|
*/
|
|
1077
1098
|
createCustomerChatChannel: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1099
|
+
/**
|
|
1100
|
+
* Create a data deletion request for a customer
|
|
1101
|
+
* @summary Create data deletion request
|
|
1102
|
+
* @param {string} project Project unique identifier
|
|
1103
|
+
* @param {string} platformId The platform identifier
|
|
1104
|
+
* @param {string} customerId The customer identifier
|
|
1105
|
+
* @param {*} [options] Override http request option.
|
|
1106
|
+
* @throws {RequiredError}
|
|
1107
|
+
*/
|
|
1108
|
+
createCustomerDataDeletionRequest: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1078
1109
|
/**
|
|
1079
1110
|
* Export customers as a CSV file
|
|
1080
1111
|
* @summary Export customers
|
|
@@ -1110,6 +1141,16 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1110
1141
|
* @throws {RequiredError}
|
|
1111
1142
|
*/
|
|
1112
1143
|
getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1144
|
+
/**
|
|
1145
|
+
* Get a data deletion request for a customer
|
|
1146
|
+
* @summary Get data deletion request
|
|
1147
|
+
* @param {string} project Project unique identifier
|
|
1148
|
+
* @param {string} platformId The platform identifier
|
|
1149
|
+
* @param {string} customerId The customer identifier
|
|
1150
|
+
* @param {*} [options] Override http request option.
|
|
1151
|
+
* @throws {RequiredError}
|
|
1152
|
+
*/
|
|
1153
|
+
getCustomerDataDeletionRequest: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1113
1154
|
/**
|
|
1114
1155
|
* List customer tags
|
|
1115
1156
|
* @summary List customer tags
|
|
@@ -1176,6 +1217,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1176
1217
|
* @throws {RequiredError}
|
|
1177
1218
|
*/
|
|
1178
1219
|
createCustomerChatChannel(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateOrderChatChannel200Response>>;
|
|
1220
|
+
/**
|
|
1221
|
+
* Create a data deletion request for a customer
|
|
1222
|
+
* @summary Create data deletion request
|
|
1223
|
+
* @param {string} project Project unique identifier
|
|
1224
|
+
* @param {string} platformId The platform identifier
|
|
1225
|
+
* @param {string} customerId The customer identifier
|
|
1226
|
+
* @param {*} [options] Override http request option.
|
|
1227
|
+
* @throws {RequiredError}
|
|
1228
|
+
*/
|
|
1229
|
+
createCustomerDataDeletionRequest(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataDeletionRequest>>;
|
|
1179
1230
|
/**
|
|
1180
1231
|
* Export customers as a CSV file
|
|
1181
1232
|
* @summary Export customers
|
|
@@ -1211,6 +1262,16 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1211
1262
|
* @throws {RequiredError}
|
|
1212
1263
|
*/
|
|
1213
1264
|
getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
|
|
1265
|
+
/**
|
|
1266
|
+
* Get a data deletion request for a customer
|
|
1267
|
+
* @summary Get data deletion request
|
|
1268
|
+
* @param {string} project Project unique identifier
|
|
1269
|
+
* @param {string} platformId The platform identifier
|
|
1270
|
+
* @param {string} customerId The customer identifier
|
|
1271
|
+
* @param {*} [options] Override http request option.
|
|
1272
|
+
* @throws {RequiredError}
|
|
1273
|
+
*/
|
|
1274
|
+
getCustomerDataDeletionRequest(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataDeletionRequest>>;
|
|
1214
1275
|
/**
|
|
1215
1276
|
* List customer tags
|
|
1216
1277
|
* @summary List customer tags
|
|
@@ -1275,6 +1336,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1275
1336
|
* @throws {RequiredError}
|
|
1276
1337
|
*/
|
|
1277
1338
|
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateOrderChatChannel200Response>;
|
|
1339
|
+
/**
|
|
1340
|
+
* Create a data deletion request for a customer
|
|
1341
|
+
* @summary Create data deletion request
|
|
1342
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
1343
|
+
* @param {*} [options] Override http request option.
|
|
1344
|
+
* @throws {RequiredError}
|
|
1345
|
+
*/
|
|
1346
|
+
createCustomerDataDeletionRequest(requestParameters: CustomersApiCreateCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataDeletionRequest>;
|
|
1278
1347
|
/**
|
|
1279
1348
|
* Export customers as a CSV file
|
|
1280
1349
|
* @summary Export customers
|
|
@@ -1291,6 +1360,14 @@ export declare const CustomersApiFactory: (configuration?: Configuration, basePa
|
|
|
1291
1360
|
* @throws {RequiredError}
|
|
1292
1361
|
*/
|
|
1293
1362
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
|
|
1363
|
+
/**
|
|
1364
|
+
* Get a data deletion request for a customer
|
|
1365
|
+
* @summary Get data deletion request
|
|
1366
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
1367
|
+
* @param {*} [options] Override http request option.
|
|
1368
|
+
* @throws {RequiredError}
|
|
1369
|
+
*/
|
|
1370
|
+
getCustomerDataDeletionRequest(requestParameters: CustomersApiGetCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<DataDeletionRequest>;
|
|
1294
1371
|
/**
|
|
1295
1372
|
* List customer tags
|
|
1296
1373
|
* @summary List customer tags
|
|
@@ -1333,6 +1410,23 @@ export interface CustomersApiCreateCustomerChatChannelRequest {
|
|
|
1333
1410
|
*/
|
|
1334
1411
|
readonly customerId: string;
|
|
1335
1412
|
}
|
|
1413
|
+
/**
|
|
1414
|
+
* Request parameters for createCustomerDataDeletionRequest operation in CustomersApi.
|
|
1415
|
+
*/
|
|
1416
|
+
export interface CustomersApiCreateCustomerDataDeletionRequestRequest {
|
|
1417
|
+
/**
|
|
1418
|
+
* Project unique identifier
|
|
1419
|
+
*/
|
|
1420
|
+
readonly project: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* The platform identifier
|
|
1423
|
+
*/
|
|
1424
|
+
readonly platformId: string;
|
|
1425
|
+
/**
|
|
1426
|
+
* The customer identifier
|
|
1427
|
+
*/
|
|
1428
|
+
readonly customerId: string;
|
|
1429
|
+
}
|
|
1336
1430
|
/**
|
|
1337
1431
|
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1338
1432
|
*/
|
|
@@ -1427,6 +1521,23 @@ export interface CustomersApiGetCustomerRequest {
|
|
|
1427
1521
|
*/
|
|
1428
1522
|
readonly customerId: string;
|
|
1429
1523
|
}
|
|
1524
|
+
/**
|
|
1525
|
+
* Request parameters for getCustomerDataDeletionRequest operation in CustomersApi.
|
|
1526
|
+
*/
|
|
1527
|
+
export interface CustomersApiGetCustomerDataDeletionRequestRequest {
|
|
1528
|
+
/**
|
|
1529
|
+
* Project unique identifier
|
|
1530
|
+
*/
|
|
1531
|
+
readonly project: string;
|
|
1532
|
+
/**
|
|
1533
|
+
* The platform identifier
|
|
1534
|
+
*/
|
|
1535
|
+
readonly platformId: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* The customer identifier
|
|
1538
|
+
*/
|
|
1539
|
+
readonly customerId: string;
|
|
1540
|
+
}
|
|
1430
1541
|
/**
|
|
1431
1542
|
* Request parameters for listCustomerTags operation in CustomersApi.
|
|
1432
1543
|
*/
|
|
@@ -1571,6 +1682,14 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
1571
1682
|
* @throws {RequiredError}
|
|
1572
1683
|
*/
|
|
1573
1684
|
createCustomerChatChannel(requestParameters: CustomersApiCreateCustomerChatChannelRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateOrderChatChannel200Response, any, {}>>;
|
|
1685
|
+
/**
|
|
1686
|
+
* Create a data deletion request for a customer
|
|
1687
|
+
* @summary Create data deletion request
|
|
1688
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
1689
|
+
* @param {*} [options] Override http request option.
|
|
1690
|
+
* @throws {RequiredError}
|
|
1691
|
+
*/
|
|
1692
|
+
createCustomerDataDeletionRequest(requestParameters: CustomersApiCreateCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataDeletionRequest, any, {}>>;
|
|
1574
1693
|
/**
|
|
1575
1694
|
* Export customers as a CSV file
|
|
1576
1695
|
* @summary Export customers
|
|
@@ -1587,6 +1706,14 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
1587
1706
|
* @throws {RequiredError}
|
|
1588
1707
|
*/
|
|
1589
1708
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any, {}>>;
|
|
1709
|
+
/**
|
|
1710
|
+
* Get a data deletion request for a customer
|
|
1711
|
+
* @summary Get data deletion request
|
|
1712
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
1713
|
+
* @param {*} [options] Override http request option.
|
|
1714
|
+
* @throws {RequiredError}
|
|
1715
|
+
*/
|
|
1716
|
+
getCustomerDataDeletionRequest(requestParameters: CustomersApiGetCustomerDataDeletionRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataDeletionRequest, any, {}>>;
|
|
1590
1717
|
/**
|
|
1591
1718
|
* List customer tags
|
|
1592
1719
|
* @summary List customer tags
|