@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/api.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Platform API
|
|
6
6
|
* Manage Your podOS platform
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 0.
|
|
8
|
+
* The version of the OpenAPI document: 0.55.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -139,6 +139,51 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
139
139
|
options: localVarRequestOptions,
|
|
140
140
|
};
|
|
141
141
|
}),
|
|
142
|
+
/**
|
|
143
|
+
* Create a data deletion request for a customer
|
|
144
|
+
* @summary Create data deletion request
|
|
145
|
+
* @param {string} project Project unique identifier
|
|
146
|
+
* @param {string} platformId The platform identifier
|
|
147
|
+
* @param {string} customerId The customer identifier
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
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 = {}) {
|
|
152
|
+
// verify required parameter 'project' is not null or undefined
|
|
153
|
+
(0, common_1.assertParamExists)('createCustomerDataDeletionRequest', 'project', project);
|
|
154
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
155
|
+
(0, common_1.assertParamExists)('createCustomerDataDeletionRequest', 'platformId', platformId);
|
|
156
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
157
|
+
(0, common_1.assertParamExists)('createCustomerDataDeletionRequest', 'customerId', customerId);
|
|
158
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/data-deletion-request`
|
|
159
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
160
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
161
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
162
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
163
|
+
let baseOptions;
|
|
164
|
+
if (configuration) {
|
|
165
|
+
baseOptions = configuration.baseOptions;
|
|
166
|
+
}
|
|
167
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
168
|
+
const localVarHeaderParameter = {};
|
|
169
|
+
const localVarQueryParameter = {};
|
|
170
|
+
// authentication session-oauth required
|
|
171
|
+
// oauth required
|
|
172
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
173
|
+
// authentication api-key required
|
|
174
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
175
|
+
if (project !== undefined) {
|
|
176
|
+
localVarQueryParameter['project'] = project;
|
|
177
|
+
}
|
|
178
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
179
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
180
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
181
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
182
|
+
return {
|
|
183
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
184
|
+
options: localVarRequestOptions,
|
|
185
|
+
};
|
|
186
|
+
}),
|
|
142
187
|
/**
|
|
143
188
|
* Export customers as a CSV file
|
|
144
189
|
* @summary Export customers
|
|
@@ -291,6 +336,51 @@ const CustomersApiAxiosParamCreator = function (configuration) {
|
|
|
291
336
|
options: localVarRequestOptions,
|
|
292
337
|
};
|
|
293
338
|
}),
|
|
339
|
+
/**
|
|
340
|
+
* Get a data deletion request for a customer
|
|
341
|
+
* @summary Get data deletion request
|
|
342
|
+
* @param {string} project Project unique identifier
|
|
343
|
+
* @param {string} platformId The platform identifier
|
|
344
|
+
* @param {string} customerId The customer identifier
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
*/
|
|
348
|
+
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 = {}) {
|
|
349
|
+
// verify required parameter 'project' is not null or undefined
|
|
350
|
+
(0, common_1.assertParamExists)('getCustomerDataDeletionRequest', 'project', project);
|
|
351
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
352
|
+
(0, common_1.assertParamExists)('getCustomerDataDeletionRequest', 'platformId', platformId);
|
|
353
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
354
|
+
(0, common_1.assertParamExists)('getCustomerDataDeletionRequest', 'customerId', customerId);
|
|
355
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}/data-deletion-request`
|
|
356
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
357
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
358
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
359
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
360
|
+
let baseOptions;
|
|
361
|
+
if (configuration) {
|
|
362
|
+
baseOptions = configuration.baseOptions;
|
|
363
|
+
}
|
|
364
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
365
|
+
const localVarHeaderParameter = {};
|
|
366
|
+
const localVarQueryParameter = {};
|
|
367
|
+
// authentication session-oauth required
|
|
368
|
+
// oauth required
|
|
369
|
+
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
370
|
+
// authentication api-key required
|
|
371
|
+
yield (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "Authorization", configuration);
|
|
372
|
+
if (project !== undefined) {
|
|
373
|
+
localVarQueryParameter['project'] = project;
|
|
374
|
+
}
|
|
375
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
376
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
377
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
378
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
379
|
+
return {
|
|
380
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
381
|
+
options: localVarRequestOptions,
|
|
382
|
+
};
|
|
383
|
+
}),
|
|
294
384
|
/**
|
|
295
385
|
* List customer tags
|
|
296
386
|
* @summary List customer tags
|
|
@@ -538,6 +628,24 @@ const CustomersApiFp = function (configuration) {
|
|
|
538
628
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
539
629
|
});
|
|
540
630
|
},
|
|
631
|
+
/**
|
|
632
|
+
* Create a data deletion request for a customer
|
|
633
|
+
* @summary Create data deletion request
|
|
634
|
+
* @param {string} project Project unique identifier
|
|
635
|
+
* @param {string} platformId The platform identifier
|
|
636
|
+
* @param {string} customerId The customer identifier
|
|
637
|
+
* @param {*} [options] Override http request option.
|
|
638
|
+
* @throws {RequiredError}
|
|
639
|
+
*/
|
|
640
|
+
createCustomerDataDeletionRequest(project, platformId, customerId, options) {
|
|
641
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
642
|
+
var _a, _b, _c;
|
|
643
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createCustomerDataDeletionRequest(project, platformId, customerId, options);
|
|
644
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
645
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.createCustomerDataDeletionRequest']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
646
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
647
|
+
});
|
|
648
|
+
},
|
|
541
649
|
/**
|
|
542
650
|
* Export customers as a CSV file
|
|
543
651
|
* @summary Export customers
|
|
@@ -589,6 +697,24 @@ const CustomersApiFp = function (configuration) {
|
|
|
589
697
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
590
698
|
});
|
|
591
699
|
},
|
|
700
|
+
/**
|
|
701
|
+
* Get a data deletion request for a customer
|
|
702
|
+
* @summary Get data deletion request
|
|
703
|
+
* @param {string} project Project unique identifier
|
|
704
|
+
* @param {string} platformId The platform identifier
|
|
705
|
+
* @param {string} customerId The customer identifier
|
|
706
|
+
* @param {*} [options] Override http request option.
|
|
707
|
+
* @throws {RequiredError}
|
|
708
|
+
*/
|
|
709
|
+
getCustomerDataDeletionRequest(project, platformId, customerId, options) {
|
|
710
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
711
|
+
var _a, _b, _c;
|
|
712
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getCustomerDataDeletionRequest(project, platformId, customerId, options);
|
|
713
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
714
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.getCustomerDataDeletionRequest']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
715
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
716
|
+
});
|
|
717
|
+
},
|
|
592
718
|
/**
|
|
593
719
|
* List customer tags
|
|
594
720
|
* @summary List customer tags
|
|
@@ -683,6 +809,16 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
683
809
|
createCustomerChatChannel(requestParameters, options) {
|
|
684
810
|
return localVarFp.createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
685
811
|
},
|
|
812
|
+
/**
|
|
813
|
+
* Create a data deletion request for a customer
|
|
814
|
+
* @summary Create data deletion request
|
|
815
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
816
|
+
* @param {*} [options] Override http request option.
|
|
817
|
+
* @throws {RequiredError}
|
|
818
|
+
*/
|
|
819
|
+
createCustomerDataDeletionRequest(requestParameters, options) {
|
|
820
|
+
return localVarFp.createCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
821
|
+
},
|
|
686
822
|
/**
|
|
687
823
|
* Export customers as a CSV file
|
|
688
824
|
* @summary Export customers
|
|
@@ -703,6 +839,16 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
|
|
|
703
839
|
getCustomer(requestParameters, options) {
|
|
704
840
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
705
841
|
},
|
|
842
|
+
/**
|
|
843
|
+
* Get a data deletion request for a customer
|
|
844
|
+
* @summary Get data deletion request
|
|
845
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
846
|
+
* @param {*} [options] Override http request option.
|
|
847
|
+
* @throws {RequiredError}
|
|
848
|
+
*/
|
|
849
|
+
getCustomerDataDeletionRequest(requestParameters, options) {
|
|
850
|
+
return localVarFp.getCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
851
|
+
},
|
|
706
852
|
/**
|
|
707
853
|
* List customer tags
|
|
708
854
|
* @summary List customer tags
|
|
@@ -750,6 +896,16 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
750
896
|
createCustomerChatChannel(requestParameters, options) {
|
|
751
897
|
return (0, exports.CustomersApiFp)(this.configuration).createCustomerChatChannel(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
752
898
|
}
|
|
899
|
+
/**
|
|
900
|
+
* Create a data deletion request for a customer
|
|
901
|
+
* @summary Create data deletion request
|
|
902
|
+
* @param {CustomersApiCreateCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
903
|
+
* @param {*} [options] Override http request option.
|
|
904
|
+
* @throws {RequiredError}
|
|
905
|
+
*/
|
|
906
|
+
createCustomerDataDeletionRequest(requestParameters, options) {
|
|
907
|
+
return (0, exports.CustomersApiFp)(this.configuration).createCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
908
|
+
}
|
|
753
909
|
/**
|
|
754
910
|
* Export customers as a CSV file
|
|
755
911
|
* @summary Export customers
|
|
@@ -770,6 +926,16 @@ class CustomersApi extends base_1.BaseAPI {
|
|
|
770
926
|
getCustomer(requestParameters, options) {
|
|
771
927
|
return (0, exports.CustomersApiFp)(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
772
928
|
}
|
|
929
|
+
/**
|
|
930
|
+
* Get a data deletion request for a customer
|
|
931
|
+
* @summary Get data deletion request
|
|
932
|
+
* @param {CustomersApiGetCustomerDataDeletionRequestRequest} requestParameters Request parameters.
|
|
933
|
+
* @param {*} [options] Override http request option.
|
|
934
|
+
* @throws {RequiredError}
|
|
935
|
+
*/
|
|
936
|
+
getCustomerDataDeletionRequest(requestParameters, options) {
|
|
937
|
+
return (0, exports.CustomersApiFp)(this.configuration).getCustomerDataDeletionRequest(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
938
|
+
}
|
|
773
939
|
/**
|
|
774
940
|
* List customer tags
|
|
775
941
|
* @summary List customer tags
|
package/dist/base.d.ts
CHANGED
package/dist/base.js
CHANGED
package/dist/common.d.ts
CHANGED
package/dist/common.js
CHANGED
package/dist/configuration.d.ts
CHANGED
package/dist/configuration.js
CHANGED
package/dist/esm/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.0
|
|
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
|
+
'requestedBy': 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
|