@teemill/platform 0.65.2 → 0.67.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/.openapi-generator/FILES +4 -0
- package/README.md +9 -2
- package/api.ts +566 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +319 -1
- package/dist/api.js +383 -3
- 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 +319 -1
- package/dist/esm/api.js +377 -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/ConciergeCandidate.md +41 -0
- package/docs/ConciergeCandidateSource.md +25 -0
- package/docs/ConciergeCandidatesApi.md +265 -0
- package/docs/ListConciergeCandidates200Response.md +22 -0
- package/docs/UpdateConciergeCandidateRequest.md +22 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -17,6 +17,9 @@ docs/AuthorizeStripe200Response.md
|
|
|
17
17
|
docs/BulkCreateReviewPayload.md
|
|
18
18
|
docs/BulkCreatedReviews.md
|
|
19
19
|
docs/Client.md
|
|
20
|
+
docs/ConciergeCandidate.md
|
|
21
|
+
docs/ConciergeCandidateSource.md
|
|
22
|
+
docs/ConciergeCandidatesApi.md
|
|
20
23
|
docs/ConfirmOrderFulfillment.md
|
|
21
24
|
docs/ConfirmOrderFulfillmentShipment.md
|
|
22
25
|
docs/ConfirmOrderRequest.md
|
|
@@ -55,6 +58,7 @@ docs/Fulfillment.md
|
|
|
55
58
|
docs/FulfillmentItem.md
|
|
56
59
|
docs/GetDashboardResponse.md
|
|
57
60
|
docs/Image.md
|
|
61
|
+
docs/ListConciergeCandidates200Response.md
|
|
58
62
|
docs/ListCustomerEnquiries200Response.md
|
|
59
63
|
docs/ListCustomerEnquiryLogs200Response.md
|
|
60
64
|
docs/ListCustomerEnquiryLogs200ResponseLogsInner.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.67.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.67.0 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -51,6 +51,10 @@ All URIs are relative to *https://localhost:8080*
|
|
|
51
51
|
|
|
52
52
|
Class | Method | HTTP request | Description
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
54
|
+
*ConciergeCandidatesApi* | [**approveConciergeCandidate**](docs/ConciergeCandidatesApi.md#approveconciergecandidate) | **POST** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}/approve | Approve concierge candidate
|
|
55
|
+
*ConciergeCandidatesApi* | [**deleteConciergeCandidate**](docs/ConciergeCandidatesApi.md#deleteconciergecandidate) | **DELETE** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Delete concierge candidate
|
|
56
|
+
*ConciergeCandidatesApi* | [**getConciergeCandidate**](docs/ConciergeCandidatesApi.md#getconciergecandidate) | **GET** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Get concierge candidate
|
|
57
|
+
*ConciergeCandidatesApi* | [**listConciergeCandidates**](docs/ConciergeCandidatesApi.md#listconciergecandidates) | **GET** /v1/platform/{platformId}/concierge-candidates | List concierge candidates
|
|
54
58
|
*CustomersApi* | [**createCustomerChatChannel**](docs/CustomersApi.md#createcustomerchatchannel) | **POST** /v1/platform/{platformId}/customers/{customerId}/chat-channel | Create chat channel
|
|
55
59
|
*CustomersApi* | [**createCustomerDataDeletionRequest**](docs/CustomersApi.md#createcustomerdatadeletionrequest) | **POST** /v1/platform/{platformId}/customers/{customerId}/data-deletion-request | Create data deletion request
|
|
56
60
|
*CustomersApi* | [**exportCustomers**](docs/CustomersApi.md#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers
|
|
@@ -122,6 +126,8 @@ Class | Method | HTTP request | Description
|
|
|
122
126
|
- [BulkCreateReviewPayload](docs/BulkCreateReviewPayload.md)
|
|
123
127
|
- [BulkCreatedReviews](docs/BulkCreatedReviews.md)
|
|
124
128
|
- [Client](docs/Client.md)
|
|
129
|
+
- [ConciergeCandidate](docs/ConciergeCandidate.md)
|
|
130
|
+
- [ConciergeCandidateSource](docs/ConciergeCandidateSource.md)
|
|
125
131
|
- [ConfirmOrderFulfillment](docs/ConfirmOrderFulfillment.md)
|
|
126
132
|
- [ConfirmOrderFulfillmentShipment](docs/ConfirmOrderFulfillmentShipment.md)
|
|
127
133
|
- [ConfirmOrderRequest](docs/ConfirmOrderRequest.md)
|
|
@@ -157,6 +163,7 @@ Class | Method | HTTP request | Description
|
|
|
157
163
|
- [FulfillmentItem](docs/FulfillmentItem.md)
|
|
158
164
|
- [GetDashboardResponse](docs/GetDashboardResponse.md)
|
|
159
165
|
- [Image](docs/Image.md)
|
|
166
|
+
- [ListConciergeCandidates200Response](docs/ListConciergeCandidates200Response.md)
|
|
160
167
|
- [ListCustomerEnquiries200Response](docs/ListCustomerEnquiries200Response.md)
|
|
161
168
|
- [ListCustomerEnquiryLogs200Response](docs/ListCustomerEnquiryLogs200Response.md)
|
|
162
169
|
- [ListCustomerEnquiryLogs200ResponseLogsInner](docs/ListCustomerEnquiryLogs200ResponseLogsInner.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.67.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -182,6 +182,79 @@ export interface Client {
|
|
|
182
182
|
'ref'?: string;
|
|
183
183
|
'name'?: string;
|
|
184
184
|
}
|
|
185
|
+
/**
|
|
186
|
+
* A concierge candidate. This is a potentially high value person who has interacted with the platform in some way.
|
|
187
|
+
*/
|
|
188
|
+
export interface ConciergeCandidate {
|
|
189
|
+
/**
|
|
190
|
+
* Unique object identifier
|
|
191
|
+
*/
|
|
192
|
+
'id': string;
|
|
193
|
+
/**
|
|
194
|
+
* The first name of the concierge candidate
|
|
195
|
+
*/
|
|
196
|
+
'firstName': string;
|
|
197
|
+
/**
|
|
198
|
+
* The last name of the concierge candidate
|
|
199
|
+
*/
|
|
200
|
+
'lastName': string;
|
|
201
|
+
/**
|
|
202
|
+
* The email of the concierge candidate
|
|
203
|
+
*/
|
|
204
|
+
'email': string;
|
|
205
|
+
'source': ConciergeCandidateSource;
|
|
206
|
+
/**
|
|
207
|
+
* ISO 8601 Timestamp
|
|
208
|
+
*/
|
|
209
|
+
'createdAt': string;
|
|
210
|
+
/**
|
|
211
|
+
* ISO 8601 Timestamp
|
|
212
|
+
*/
|
|
213
|
+
'approvedAt': string | null;
|
|
214
|
+
/**
|
|
215
|
+
* ISO 8601 Timestamp
|
|
216
|
+
*/
|
|
217
|
+
'completedAt': string | null;
|
|
218
|
+
/**
|
|
219
|
+
* A reference to the project being ordered
|
|
220
|
+
*/
|
|
221
|
+
'clientRef': string;
|
|
222
|
+
/**
|
|
223
|
+
* A reference to the origin of the concierge candidate. The structure of the origin ref can be inferred from the concierge candidate source.
|
|
224
|
+
*/
|
|
225
|
+
'originRef': string;
|
|
226
|
+
/**
|
|
227
|
+
* Reference to the task resource
|
|
228
|
+
*/
|
|
229
|
+
'taskRef'?: string | null;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* The source of the concierge candidate. This is the channel through which the concierge candidate interacted with the platform.
|
|
233
|
+
*/
|
|
234
|
+
export interface ConciergeCandidateSource {
|
|
235
|
+
/**
|
|
236
|
+
* The type of the source
|
|
237
|
+
*/
|
|
238
|
+
'type': ConciergeCandidateSourceTypeEnum;
|
|
239
|
+
/**
|
|
240
|
+
* The name of the source
|
|
241
|
+
*/
|
|
242
|
+
'name': string;
|
|
243
|
+
/**
|
|
244
|
+
* The description of the source
|
|
245
|
+
*/
|
|
246
|
+
'description': string;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
export const ConciergeCandidateSourceTypeEnum = {
|
|
250
|
+
ContactForm: 'contact_form',
|
|
251
|
+
SignedUp: 'signed_up',
|
|
252
|
+
CustomOrder: 'custom_order',
|
|
253
|
+
QuoteForm: 'quote_form',
|
|
254
|
+
} as const;
|
|
255
|
+
|
|
256
|
+
export type ConciergeCandidateSourceTypeEnum = typeof ConciergeCandidateSourceTypeEnum[keyof typeof ConciergeCandidateSourceTypeEnum];
|
|
257
|
+
|
|
185
258
|
export interface ConfirmOrderFulfillment {
|
|
186
259
|
/**
|
|
187
260
|
* Unique object identifier
|
|
@@ -603,6 +676,10 @@ export interface Image {
|
|
|
603
676
|
'alt'?: string;
|
|
604
677
|
'sortOrder'?: number;
|
|
605
678
|
}
|
|
679
|
+
export interface ListConciergeCandidates200Response {
|
|
680
|
+
'candidates': Array<ConciergeCandidate>;
|
|
681
|
+
'nextPageToken': number | null;
|
|
682
|
+
}
|
|
606
683
|
export interface ListCustomerEnquiries200Response {
|
|
607
684
|
'enquiries'?: Array<Enquiry>;
|
|
608
685
|
'nextPageToken'?: number | null;
|
|
@@ -1265,6 +1342,494 @@ export interface Variant {
|
|
|
1265
1342
|
'warehouseVariantRef': string | null;
|
|
1266
1343
|
}
|
|
1267
1344
|
|
|
1345
|
+
/**
|
|
1346
|
+
* ConciergeCandidatesApi - axios parameter creator
|
|
1347
|
+
*/
|
|
1348
|
+
export const ConciergeCandidatesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1349
|
+
return {
|
|
1350
|
+
/**
|
|
1351
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
1352
|
+
* @summary Approve concierge candidate
|
|
1353
|
+
* @param {string} project Project unique identifier
|
|
1354
|
+
* @param {string} platformId The platform identifier
|
|
1355
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
1356
|
+
* @param {*} [options] Override http request option.
|
|
1357
|
+
* @throws {RequiredError}
|
|
1358
|
+
*/
|
|
1359
|
+
approveConciergeCandidate: async (project: string, platformId: string, conciergeCandidateId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1360
|
+
// verify required parameter 'project' is not null or undefined
|
|
1361
|
+
assertParamExists('approveConciergeCandidate', 'project', project)
|
|
1362
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1363
|
+
assertParamExists('approveConciergeCandidate', 'platformId', platformId)
|
|
1364
|
+
// verify required parameter 'conciergeCandidateId' is not null or undefined
|
|
1365
|
+
assertParamExists('approveConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId)
|
|
1366
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}/approve`
|
|
1367
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1368
|
+
.replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
|
|
1369
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1370
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1371
|
+
let baseOptions;
|
|
1372
|
+
if (configuration) {
|
|
1373
|
+
baseOptions = configuration.baseOptions;
|
|
1374
|
+
}
|
|
1375
|
+
|
|
1376
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
1377
|
+
const localVarHeaderParameter = {} as any;
|
|
1378
|
+
const localVarQueryParameter = {} as any;
|
|
1379
|
+
|
|
1380
|
+
// authentication session-oauth required
|
|
1381
|
+
// oauth required
|
|
1382
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1383
|
+
|
|
1384
|
+
// authentication api-key required
|
|
1385
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1386
|
+
|
|
1387
|
+
if (project !== undefined) {
|
|
1388
|
+
localVarQueryParameter['project'] = project;
|
|
1389
|
+
}
|
|
1390
|
+
|
|
1391
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1392
|
+
|
|
1393
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1394
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1395
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1396
|
+
|
|
1397
|
+
return {
|
|
1398
|
+
url: toPathString(localVarUrlObj),
|
|
1399
|
+
options: localVarRequestOptions,
|
|
1400
|
+
};
|
|
1401
|
+
},
|
|
1402
|
+
/**
|
|
1403
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
1404
|
+
* @summary Delete concierge candidate
|
|
1405
|
+
* @param {string} project Project unique identifier
|
|
1406
|
+
* @param {string} platformId The platform identifier
|
|
1407
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
1408
|
+
* @param {*} [options] Override http request option.
|
|
1409
|
+
* @throws {RequiredError}
|
|
1410
|
+
*/
|
|
1411
|
+
deleteConciergeCandidate: async (project: string, platformId: string, conciergeCandidateId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1412
|
+
// verify required parameter 'project' is not null or undefined
|
|
1413
|
+
assertParamExists('deleteConciergeCandidate', 'project', project)
|
|
1414
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1415
|
+
assertParamExists('deleteConciergeCandidate', 'platformId', platformId)
|
|
1416
|
+
// verify required parameter 'conciergeCandidateId' is not null or undefined
|
|
1417
|
+
assertParamExists('deleteConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId)
|
|
1418
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}`
|
|
1419
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1420
|
+
.replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
|
|
1421
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1422
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1423
|
+
let baseOptions;
|
|
1424
|
+
if (configuration) {
|
|
1425
|
+
baseOptions = configuration.baseOptions;
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1428
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
1429
|
+
const localVarHeaderParameter = {} as any;
|
|
1430
|
+
const localVarQueryParameter = {} as any;
|
|
1431
|
+
|
|
1432
|
+
// authentication session-oauth required
|
|
1433
|
+
// oauth required
|
|
1434
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1435
|
+
|
|
1436
|
+
// authentication api-key required
|
|
1437
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1438
|
+
|
|
1439
|
+
if (project !== undefined) {
|
|
1440
|
+
localVarQueryParameter['project'] = project;
|
|
1441
|
+
}
|
|
1442
|
+
|
|
1443
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1444
|
+
|
|
1445
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1446
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1447
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1448
|
+
|
|
1449
|
+
return {
|
|
1450
|
+
url: toPathString(localVarUrlObj),
|
|
1451
|
+
options: localVarRequestOptions,
|
|
1452
|
+
};
|
|
1453
|
+
},
|
|
1454
|
+
/**
|
|
1455
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
1456
|
+
* @summary Get concierge candidate
|
|
1457
|
+
* @param {string} project Project unique identifier
|
|
1458
|
+
* @param {string} platformId The platform identifier
|
|
1459
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
1460
|
+
* @param {*} [options] Override http request option.
|
|
1461
|
+
* @throws {RequiredError}
|
|
1462
|
+
*/
|
|
1463
|
+
getConciergeCandidate: async (project: string, platformId: string, conciergeCandidateId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1464
|
+
// verify required parameter 'project' is not null or undefined
|
|
1465
|
+
assertParamExists('getConciergeCandidate', 'project', project)
|
|
1466
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1467
|
+
assertParamExists('getConciergeCandidate', 'platformId', platformId)
|
|
1468
|
+
// verify required parameter 'conciergeCandidateId' is not null or undefined
|
|
1469
|
+
assertParamExists('getConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId)
|
|
1470
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}`
|
|
1471
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1472
|
+
.replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
|
|
1473
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1474
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1475
|
+
let baseOptions;
|
|
1476
|
+
if (configuration) {
|
|
1477
|
+
baseOptions = configuration.baseOptions;
|
|
1478
|
+
}
|
|
1479
|
+
|
|
1480
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1481
|
+
const localVarHeaderParameter = {} as any;
|
|
1482
|
+
const localVarQueryParameter = {} as any;
|
|
1483
|
+
|
|
1484
|
+
// authentication session-oauth required
|
|
1485
|
+
// oauth required
|
|
1486
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1487
|
+
|
|
1488
|
+
// authentication api-key required
|
|
1489
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1490
|
+
|
|
1491
|
+
if (project !== undefined) {
|
|
1492
|
+
localVarQueryParameter['project'] = project;
|
|
1493
|
+
}
|
|
1494
|
+
|
|
1495
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1496
|
+
|
|
1497
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1498
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1499
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1500
|
+
|
|
1501
|
+
return {
|
|
1502
|
+
url: toPathString(localVarUrlObj),
|
|
1503
|
+
options: localVarRequestOptions,
|
|
1504
|
+
};
|
|
1505
|
+
},
|
|
1506
|
+
/**
|
|
1507
|
+
* List concierge candidates
|
|
1508
|
+
* @summary List concierge candidates
|
|
1509
|
+
* @param {string} project Project unique identifier
|
|
1510
|
+
* @param {string} platformId The platform identifier
|
|
1511
|
+
* @param {string} [search] Search term to filter results
|
|
1512
|
+
* @param {number} [pageToken] Page reference token
|
|
1513
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1514
|
+
* @param {*} [options] Override http request option.
|
|
1515
|
+
* @throws {RequiredError}
|
|
1516
|
+
*/
|
|
1517
|
+
listConciergeCandidates: async (project: string, platformId: string, search?: string, pageToken?: number, pageSize?: number, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1518
|
+
// verify required parameter 'project' is not null or undefined
|
|
1519
|
+
assertParamExists('listConciergeCandidates', 'project', project)
|
|
1520
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1521
|
+
assertParamExists('listConciergeCandidates', 'platformId', platformId)
|
|
1522
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates`
|
|
1523
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1524
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1525
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1526
|
+
let baseOptions;
|
|
1527
|
+
if (configuration) {
|
|
1528
|
+
baseOptions = configuration.baseOptions;
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1531
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1532
|
+
const localVarHeaderParameter = {} as any;
|
|
1533
|
+
const localVarQueryParameter = {} as any;
|
|
1534
|
+
|
|
1535
|
+
// authentication session-oauth required
|
|
1536
|
+
// oauth required
|
|
1537
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1538
|
+
|
|
1539
|
+
// authentication api-key required
|
|
1540
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1541
|
+
|
|
1542
|
+
if (project !== undefined) {
|
|
1543
|
+
localVarQueryParameter['project'] = project;
|
|
1544
|
+
}
|
|
1545
|
+
|
|
1546
|
+
if (search !== undefined) {
|
|
1547
|
+
localVarQueryParameter['search'] = search;
|
|
1548
|
+
}
|
|
1549
|
+
|
|
1550
|
+
if (pageToken !== undefined) {
|
|
1551
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
1552
|
+
}
|
|
1553
|
+
|
|
1554
|
+
if (pageSize !== undefined) {
|
|
1555
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1556
|
+
}
|
|
1557
|
+
|
|
1558
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
1559
|
+
|
|
1560
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1561
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1562
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1563
|
+
|
|
1564
|
+
return {
|
|
1565
|
+
url: toPathString(localVarUrlObj),
|
|
1566
|
+
options: localVarRequestOptions,
|
|
1567
|
+
};
|
|
1568
|
+
},
|
|
1569
|
+
}
|
|
1570
|
+
};
|
|
1571
|
+
|
|
1572
|
+
/**
|
|
1573
|
+
* ConciergeCandidatesApi - functional programming interface
|
|
1574
|
+
*/
|
|
1575
|
+
export const ConciergeCandidatesApiFp = function(configuration?: Configuration) {
|
|
1576
|
+
const localVarAxiosParamCreator = ConciergeCandidatesApiAxiosParamCreator(configuration)
|
|
1577
|
+
return {
|
|
1578
|
+
/**
|
|
1579
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
1580
|
+
* @summary Approve concierge candidate
|
|
1581
|
+
* @param {string} project Project unique identifier
|
|
1582
|
+
* @param {string} platformId The platform identifier
|
|
1583
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
1584
|
+
* @param {*} [options] Override http request option.
|
|
1585
|
+
* @throws {RequiredError}
|
|
1586
|
+
*/
|
|
1587
|
+
async approveConciergeCandidate(project: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConciergeCandidate>> {
|
|
1588
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.approveConciergeCandidate(project, platformId, conciergeCandidateId, options);
|
|
1589
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1590
|
+
const localVarOperationServerBasePath = operationServerMap['ConciergeCandidatesApi.approveConciergeCandidate']?.[localVarOperationServerIndex]?.url;
|
|
1591
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1592
|
+
},
|
|
1593
|
+
/**
|
|
1594
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
1595
|
+
* @summary Delete concierge candidate
|
|
1596
|
+
* @param {string} project Project unique identifier
|
|
1597
|
+
* @param {string} platformId The platform identifier
|
|
1598
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
1599
|
+
* @param {*} [options] Override http request option.
|
|
1600
|
+
* @throws {RequiredError}
|
|
1601
|
+
*/
|
|
1602
|
+
async deleteConciergeCandidate(project: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
1603
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteConciergeCandidate(project, platformId, conciergeCandidateId, options);
|
|
1604
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1605
|
+
const localVarOperationServerBasePath = operationServerMap['ConciergeCandidatesApi.deleteConciergeCandidate']?.[localVarOperationServerIndex]?.url;
|
|
1606
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1607
|
+
},
|
|
1608
|
+
/**
|
|
1609
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
1610
|
+
* @summary Get concierge candidate
|
|
1611
|
+
* @param {string} project Project unique identifier
|
|
1612
|
+
* @param {string} platformId The platform identifier
|
|
1613
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
1614
|
+
* @param {*} [options] Override http request option.
|
|
1615
|
+
* @throws {RequiredError}
|
|
1616
|
+
*/
|
|
1617
|
+
async getConciergeCandidate(project: string, platformId: string, conciergeCandidateId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConciergeCandidate>> {
|
|
1618
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getConciergeCandidate(project, platformId, conciergeCandidateId, options);
|
|
1619
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1620
|
+
const localVarOperationServerBasePath = operationServerMap['ConciergeCandidatesApi.getConciergeCandidate']?.[localVarOperationServerIndex]?.url;
|
|
1621
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1622
|
+
},
|
|
1623
|
+
/**
|
|
1624
|
+
* List concierge candidates
|
|
1625
|
+
* @summary List concierge candidates
|
|
1626
|
+
* @param {string} project Project unique identifier
|
|
1627
|
+
* @param {string} platformId The platform identifier
|
|
1628
|
+
* @param {string} [search] Search term to filter results
|
|
1629
|
+
* @param {number} [pageToken] Page reference token
|
|
1630
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1631
|
+
* @param {*} [options] Override http request option.
|
|
1632
|
+
* @throws {RequiredError}
|
|
1633
|
+
*/
|
|
1634
|
+
async listConciergeCandidates(project: string, platformId: string, search?: string, pageToken?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConciergeCandidates200Response>> {
|
|
1635
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listConciergeCandidates(project, platformId, search, pageToken, pageSize, options);
|
|
1636
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1637
|
+
const localVarOperationServerBasePath = operationServerMap['ConciergeCandidatesApi.listConciergeCandidates']?.[localVarOperationServerIndex]?.url;
|
|
1638
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1639
|
+
},
|
|
1640
|
+
}
|
|
1641
|
+
};
|
|
1642
|
+
|
|
1643
|
+
/**
|
|
1644
|
+
* ConciergeCandidatesApi - factory interface
|
|
1645
|
+
*/
|
|
1646
|
+
export const ConciergeCandidatesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1647
|
+
const localVarFp = ConciergeCandidatesApiFp(configuration)
|
|
1648
|
+
return {
|
|
1649
|
+
/**
|
|
1650
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
1651
|
+
* @summary Approve concierge candidate
|
|
1652
|
+
* @param {ConciergeCandidatesApiApproveConciergeCandidateRequest} requestParameters Request parameters.
|
|
1653
|
+
* @param {*} [options] Override http request option.
|
|
1654
|
+
* @throws {RequiredError}
|
|
1655
|
+
*/
|
|
1656
|
+
approveConciergeCandidate(requestParameters: ConciergeCandidatesApiApproveConciergeCandidateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConciergeCandidate> {
|
|
1657
|
+
return localVarFp.approveConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(axios, basePath));
|
|
1658
|
+
},
|
|
1659
|
+
/**
|
|
1660
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
1661
|
+
* @summary Delete concierge candidate
|
|
1662
|
+
* @param {ConciergeCandidatesApiDeleteConciergeCandidateRequest} requestParameters Request parameters.
|
|
1663
|
+
* @param {*} [options] Override http request option.
|
|
1664
|
+
* @throws {RequiredError}
|
|
1665
|
+
*/
|
|
1666
|
+
deleteConciergeCandidate(requestParameters: ConciergeCandidatesApiDeleteConciergeCandidateRequest, options?: RawAxiosRequestConfig): AxiosPromise<void> {
|
|
1667
|
+
return localVarFp.deleteConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(axios, basePath));
|
|
1668
|
+
},
|
|
1669
|
+
/**
|
|
1670
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
1671
|
+
* @summary Get concierge candidate
|
|
1672
|
+
* @param {ConciergeCandidatesApiGetConciergeCandidateRequest} requestParameters Request parameters.
|
|
1673
|
+
* @param {*} [options] Override http request option.
|
|
1674
|
+
* @throws {RequiredError}
|
|
1675
|
+
*/
|
|
1676
|
+
getConciergeCandidate(requestParameters: ConciergeCandidatesApiGetConciergeCandidateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConciergeCandidate> {
|
|
1677
|
+
return localVarFp.getConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(axios, basePath));
|
|
1678
|
+
},
|
|
1679
|
+
/**
|
|
1680
|
+
* List concierge candidates
|
|
1681
|
+
* @summary List concierge candidates
|
|
1682
|
+
* @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
|
|
1683
|
+
* @param {*} [options] Override http request option.
|
|
1684
|
+
* @throws {RequiredError}
|
|
1685
|
+
*/
|
|
1686
|
+
listConciergeCandidates(requestParameters: ConciergeCandidatesApiListConciergeCandidatesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListConciergeCandidates200Response> {
|
|
1687
|
+
return localVarFp.listConciergeCandidates(requestParameters.project, requestParameters.platformId, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
1688
|
+
},
|
|
1689
|
+
};
|
|
1690
|
+
};
|
|
1691
|
+
|
|
1692
|
+
/**
|
|
1693
|
+
* Request parameters for approveConciergeCandidate operation in ConciergeCandidatesApi.
|
|
1694
|
+
*/
|
|
1695
|
+
export interface ConciergeCandidatesApiApproveConciergeCandidateRequest {
|
|
1696
|
+
/**
|
|
1697
|
+
* Project unique identifier
|
|
1698
|
+
*/
|
|
1699
|
+
readonly project: string
|
|
1700
|
+
|
|
1701
|
+
/**
|
|
1702
|
+
* The platform identifier
|
|
1703
|
+
*/
|
|
1704
|
+
readonly platformId: string
|
|
1705
|
+
|
|
1706
|
+
/**
|
|
1707
|
+
* The concierge candidate identifier
|
|
1708
|
+
*/
|
|
1709
|
+
readonly conciergeCandidateId: string
|
|
1710
|
+
}
|
|
1711
|
+
|
|
1712
|
+
/**
|
|
1713
|
+
* Request parameters for deleteConciergeCandidate operation in ConciergeCandidatesApi.
|
|
1714
|
+
*/
|
|
1715
|
+
export interface ConciergeCandidatesApiDeleteConciergeCandidateRequest {
|
|
1716
|
+
/**
|
|
1717
|
+
* Project unique identifier
|
|
1718
|
+
*/
|
|
1719
|
+
readonly project: string
|
|
1720
|
+
|
|
1721
|
+
/**
|
|
1722
|
+
* The platform identifier
|
|
1723
|
+
*/
|
|
1724
|
+
readonly platformId: string
|
|
1725
|
+
|
|
1726
|
+
/**
|
|
1727
|
+
* The concierge candidate identifier
|
|
1728
|
+
*/
|
|
1729
|
+
readonly conciergeCandidateId: string
|
|
1730
|
+
}
|
|
1731
|
+
|
|
1732
|
+
/**
|
|
1733
|
+
* Request parameters for getConciergeCandidate operation in ConciergeCandidatesApi.
|
|
1734
|
+
*/
|
|
1735
|
+
export interface ConciergeCandidatesApiGetConciergeCandidateRequest {
|
|
1736
|
+
/**
|
|
1737
|
+
* Project unique identifier
|
|
1738
|
+
*/
|
|
1739
|
+
readonly project: string
|
|
1740
|
+
|
|
1741
|
+
/**
|
|
1742
|
+
* The platform identifier
|
|
1743
|
+
*/
|
|
1744
|
+
readonly platformId: string
|
|
1745
|
+
|
|
1746
|
+
/**
|
|
1747
|
+
* The concierge candidate identifier
|
|
1748
|
+
*/
|
|
1749
|
+
readonly conciergeCandidateId: string
|
|
1750
|
+
}
|
|
1751
|
+
|
|
1752
|
+
/**
|
|
1753
|
+
* Request parameters for listConciergeCandidates operation in ConciergeCandidatesApi.
|
|
1754
|
+
*/
|
|
1755
|
+
export interface ConciergeCandidatesApiListConciergeCandidatesRequest {
|
|
1756
|
+
/**
|
|
1757
|
+
* Project unique identifier
|
|
1758
|
+
*/
|
|
1759
|
+
readonly project: string
|
|
1760
|
+
|
|
1761
|
+
/**
|
|
1762
|
+
* The platform identifier
|
|
1763
|
+
*/
|
|
1764
|
+
readonly platformId: string
|
|
1765
|
+
|
|
1766
|
+
/**
|
|
1767
|
+
* Search term to filter results
|
|
1768
|
+
*/
|
|
1769
|
+
readonly search?: string
|
|
1770
|
+
|
|
1771
|
+
/**
|
|
1772
|
+
* Page reference token
|
|
1773
|
+
*/
|
|
1774
|
+
readonly pageToken?: number
|
|
1775
|
+
|
|
1776
|
+
/**
|
|
1777
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1778
|
+
*/
|
|
1779
|
+
readonly pageSize?: number
|
|
1780
|
+
}
|
|
1781
|
+
|
|
1782
|
+
/**
|
|
1783
|
+
* ConciergeCandidatesApi - object-oriented interface
|
|
1784
|
+
*/
|
|
1785
|
+
export class ConciergeCandidatesApi extends BaseAPI {
|
|
1786
|
+
/**
|
|
1787
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
1788
|
+
* @summary Approve concierge candidate
|
|
1789
|
+
* @param {ConciergeCandidatesApiApproveConciergeCandidateRequest} requestParameters Request parameters.
|
|
1790
|
+
* @param {*} [options] Override http request option.
|
|
1791
|
+
* @throws {RequiredError}
|
|
1792
|
+
*/
|
|
1793
|
+
public approveConciergeCandidate(requestParameters: ConciergeCandidatesApiApproveConciergeCandidateRequest, options?: RawAxiosRequestConfig) {
|
|
1794
|
+
return ConciergeCandidatesApiFp(this.configuration).approveConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(this.axios, this.basePath));
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1797
|
+
/**
|
|
1798
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
1799
|
+
* @summary Delete concierge candidate
|
|
1800
|
+
* @param {ConciergeCandidatesApiDeleteConciergeCandidateRequest} requestParameters Request parameters.
|
|
1801
|
+
* @param {*} [options] Override http request option.
|
|
1802
|
+
* @throws {RequiredError}
|
|
1803
|
+
*/
|
|
1804
|
+
public deleteConciergeCandidate(requestParameters: ConciergeCandidatesApiDeleteConciergeCandidateRequest, options?: RawAxiosRequestConfig) {
|
|
1805
|
+
return ConciergeCandidatesApiFp(this.configuration).deleteConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(this.axios, this.basePath));
|
|
1806
|
+
}
|
|
1807
|
+
|
|
1808
|
+
/**
|
|
1809
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
1810
|
+
* @summary Get concierge candidate
|
|
1811
|
+
* @param {ConciergeCandidatesApiGetConciergeCandidateRequest} requestParameters Request parameters.
|
|
1812
|
+
* @param {*} [options] Override http request option.
|
|
1813
|
+
* @throws {RequiredError}
|
|
1814
|
+
*/
|
|
1815
|
+
public getConciergeCandidate(requestParameters: ConciergeCandidatesApiGetConciergeCandidateRequest, options?: RawAxiosRequestConfig) {
|
|
1816
|
+
return ConciergeCandidatesApiFp(this.configuration).getConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(this.axios, this.basePath));
|
|
1817
|
+
}
|
|
1818
|
+
|
|
1819
|
+
/**
|
|
1820
|
+
* List concierge candidates
|
|
1821
|
+
* @summary List concierge candidates
|
|
1822
|
+
* @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
|
|
1823
|
+
* @param {*} [options] Override http request option.
|
|
1824
|
+
* @throws {RequiredError}
|
|
1825
|
+
*/
|
|
1826
|
+
public listConciergeCandidates(requestParameters: ConciergeCandidatesApiListConciergeCandidatesRequest, options?: RawAxiosRequestConfig) {
|
|
1827
|
+
return ConciergeCandidatesApiFp(this.configuration).listConciergeCandidates(requestParameters.project, requestParameters.platformId, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
1828
|
+
}
|
|
1829
|
+
}
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
|
|
1268
1833
|
/**
|
|
1269
1834
|
* CustomersApi - axios parameter creator
|
|
1270
1835
|
*/
|
package/base.ts
CHANGED
package/common.ts
CHANGED