@teemill/platform 0.54.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 +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/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
|
|
@@ -533,6 +623,24 @@ export const CustomersApiFp = function (configuration) {
|
|
|
533
623
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
534
624
|
});
|
|
535
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
|
+
},
|
|
536
644
|
/**
|
|
537
645
|
* Export customers as a CSV file
|
|
538
646
|
* @summary Export customers
|
|
@@ -584,6 +692,24 @@ export const CustomersApiFp = function (configuration) {
|
|
|
584
692
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
585
693
|
});
|
|
586
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
|
+
},
|
|
587
713
|
/**
|
|
588
714
|
* List customer tags
|
|
589
715
|
* @summary List customer tags
|
|
@@ -677,6 +803,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
677
803
|
createCustomerChatChannel(requestParameters, options) {
|
|
678
804
|
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
679
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
|
+
},
|
|
680
816
|
/**
|
|
681
817
|
* Export customers as a CSV file
|
|
682
818
|
* @summary Export customers
|
|
@@ -697,6 +833,16 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
697
833
|
getCustomer(requestParameters, options) {
|
|
698
834
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
699
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
|
+
},
|
|
700
846
|
/**
|
|
701
847
|
* List customer tags
|
|
702
848
|
* @summary List customer tags
|
|
@@ -743,6 +889,16 @@ export class CustomersApi extends BaseAPI {
|
|
|
743
889
|
createCustomerChatChannel(requestParameters, options) {
|
|
744
890
|
return CustomersApiFp(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
745
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
|
+
}
|
|
746
902
|
/**
|
|
747
903
|
* Export customers as a CSV file
|
|
748
904
|
* @summary Export customers
|
|
@@ -763,6 +919,16 @@ export class CustomersApi extends BaseAPI {
|
|
|
763
919
|
getCustomer(requestParameters, options) {
|
|
764
920
|
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
765
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
|
+
}
|
|
766
932
|
/**
|
|
767
933
|
* List customer tags
|
|
768
934
|
* @summary List customer tags
|
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/CustomersApi.md
CHANGED
|
@@ -5,8 +5,10 @@ All URIs are relative to *https://localhost:8080*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**createCustomerChatChannel**](#createcustomerchatchannel) | **POST** /v1/platform/{platformId}/customers/{customerId}/chat-channel | Create chat channel|
|
|
8
|
+
|[**createCustomerDataDeletionRequest**](#createcustomerdatadeletionrequest) | **POST** /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Create data deletion request|
|
|
8
9
|
|[**exportCustomers**](#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers|
|
|
9
10
|
|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
|
|
11
|
+
|[**getCustomerDataDeletionRequest**](#getcustomerdatadeletionrequest) | **GET** /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Get data deletion request|
|
|
10
12
|
|[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
|
|
11
13
|
|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
|
|
12
14
|
|[**updateCustomer**](#updatecustomer) | **PATCH** /v1/platform/{platformId}/customers/{customerId} | Update the customer with the given customer ID|
|
|
@@ -73,6 +75,67 @@ const { status, data } = await apiInstance.createCustomerChatChannel(
|
|
|
73
75
|
|
|
74
76
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
75
77
|
|
|
78
|
+
# **createCustomerDataDeletionRequest**
|
|
79
|
+
> DataDeletionRequest createCustomerDataDeletionRequest()
|
|
80
|
+
|
|
81
|
+
Create a data deletion request for a customer
|
|
82
|
+
|
|
83
|
+
### Example
|
|
84
|
+
|
|
85
|
+
```typescript
|
|
86
|
+
import {
|
|
87
|
+
CustomersApi,
|
|
88
|
+
Configuration
|
|
89
|
+
} from '@teemill/platform';
|
|
90
|
+
|
|
91
|
+
const configuration = new Configuration();
|
|
92
|
+
const apiInstance = new CustomersApi(configuration);
|
|
93
|
+
|
|
94
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
95
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
96
|
+
let customerId: string; //The customer identifier (default to undefined)
|
|
97
|
+
|
|
98
|
+
const { status, data } = await apiInstance.createCustomerDataDeletionRequest(
|
|
99
|
+
project,
|
|
100
|
+
platformId,
|
|
101
|
+
customerId
|
|
102
|
+
);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Parameters
|
|
106
|
+
|
|
107
|
+
|Name | Type | Description | Notes|
|
|
108
|
+
|------------- | ------------- | ------------- | -------------|
|
|
109
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
110
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
111
|
+
| **customerId** | [**string**] | The customer identifier | defaults to undefined|
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
### Return type
|
|
115
|
+
|
|
116
|
+
**DataDeletionRequest**
|
|
117
|
+
|
|
118
|
+
### Authorization
|
|
119
|
+
|
|
120
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
121
|
+
|
|
122
|
+
### HTTP request headers
|
|
123
|
+
|
|
124
|
+
- **Content-Type**: Not defined
|
|
125
|
+
- **Accept**: application/json
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
### HTTP response details
|
|
129
|
+
| Status code | Description | Response headers |
|
|
130
|
+
|-------------|-------------|------------------|
|
|
131
|
+
|**201** | Data deletion request | - |
|
|
132
|
+
|**401** | Not authorised to access this resource | - |
|
|
133
|
+
|**403** | Refuse to authorize | - |
|
|
134
|
+
|**404** | Resource not found | - |
|
|
135
|
+
|**500** | Unknown server error | - |
|
|
136
|
+
|
|
137
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
138
|
+
|
|
76
139
|
# **exportCustomers**
|
|
77
140
|
> File exportCustomers()
|
|
78
141
|
|
|
@@ -243,6 +306,67 @@ const { status, data } = await apiInstance.getCustomer(
|
|
|
243
306
|
|
|
244
307
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
245
308
|
|
|
309
|
+
# **getCustomerDataDeletionRequest**
|
|
310
|
+
> DataDeletionRequest getCustomerDataDeletionRequest()
|
|
311
|
+
|
|
312
|
+
Get a data deletion request for a customer
|
|
313
|
+
|
|
314
|
+
### Example
|
|
315
|
+
|
|
316
|
+
```typescript
|
|
317
|
+
import {
|
|
318
|
+
CustomersApi,
|
|
319
|
+
Configuration
|
|
320
|
+
} from '@teemill/platform';
|
|
321
|
+
|
|
322
|
+
const configuration = new Configuration();
|
|
323
|
+
const apiInstance = new CustomersApi(configuration);
|
|
324
|
+
|
|
325
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
326
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
327
|
+
let customerId: string; //The customer identifier (default to undefined)
|
|
328
|
+
|
|
329
|
+
const { status, data } = await apiInstance.getCustomerDataDeletionRequest(
|
|
330
|
+
project,
|
|
331
|
+
platformId,
|
|
332
|
+
customerId
|
|
333
|
+
);
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### Parameters
|
|
337
|
+
|
|
338
|
+
|Name | Type | Description | Notes|
|
|
339
|
+
|------------- | ------------- | ------------- | -------------|
|
|
340
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
341
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
342
|
+
| **customerId** | [**string**] | The customer identifier | defaults to undefined|
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
### Return type
|
|
346
|
+
|
|
347
|
+
**DataDeletionRequest**
|
|
348
|
+
|
|
349
|
+
### Authorization
|
|
350
|
+
|
|
351
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
352
|
+
|
|
353
|
+
### HTTP request headers
|
|
354
|
+
|
|
355
|
+
- **Content-Type**: Not defined
|
|
356
|
+
- **Accept**: application/json
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
### HTTP response details
|
|
360
|
+
| Status code | Description | Response headers |
|
|
361
|
+
|-------------|-------------|------------------|
|
|
362
|
+
|**200** | Data deletion request | - |
|
|
363
|
+
|**401** | Not authorised to access this resource | - |
|
|
364
|
+
|**403** | Refuse to authorize | - |
|
|
365
|
+
|**404** | Resource not found | - |
|
|
366
|
+
|**500** | Unknown server error | - |
|
|
367
|
+
|
|
368
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
369
|
+
|
|
246
370
|
# **listCustomerTags**
|
|
247
371
|
> ListCustomerTags200Response listCustomerTags()
|
|
248
372
|
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# DataDeletionRequest
|
|
2
|
+
|
|
3
|
+
Data deletion request
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
10
|
+
**customerRef** | **string** | Reference to the customer resource | [default to undefined]
|
|
11
|
+
**requestedBy** | **string** | Reference to the user resource | [default to undefined]
|
|
12
|
+
**requestedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { DataDeletionRequest } from '@teemill/platform';
|
|
18
|
+
|
|
19
|
+
const instance: DataDeletionRequest = {
|
|
20
|
+
id,
|
|
21
|
+
customerRef,
|
|
22
|
+
requestedBy,
|
|
23
|
+
requestedAt,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/index.ts
CHANGED