@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/dist/esm/api.js
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).
|
|
@@ -39,6 +39,12 @@ export const ApplicationPlacementEnum = {
|
|
|
39
39
|
Front: 'front',
|
|
40
40
|
Back: 'back',
|
|
41
41
|
};
|
|
42
|
+
export const ConciergeCandidateSourceTypeEnum = {
|
|
43
|
+
ContactForm: 'contact_form',
|
|
44
|
+
SignedUp: 'signed_up',
|
|
45
|
+
CustomOrder: 'custom_order',
|
|
46
|
+
QuoteForm: 'quote_form',
|
|
47
|
+
};
|
|
42
48
|
export const CreateOrderPaymentMethodTypeEnum = {
|
|
43
49
|
Card: 'card',
|
|
44
50
|
Bacs: 'bacs',
|
|
@@ -97,6 +103,376 @@ export const UpdateModerationItemRequestJudgementEnum = {
|
|
|
97
103
|
Approved: 'approved',
|
|
98
104
|
Denied: 'denied',
|
|
99
105
|
};
|
|
106
|
+
/**
|
|
107
|
+
* ConciergeCandidatesApi - axios parameter creator
|
|
108
|
+
*/
|
|
109
|
+
export const ConciergeCandidatesApiAxiosParamCreator = function (configuration) {
|
|
110
|
+
return {
|
|
111
|
+
/**
|
|
112
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
113
|
+
* @summary Approve concierge candidate
|
|
114
|
+
* @param {string} project Project unique identifier
|
|
115
|
+
* @param {string} platformId The platform identifier
|
|
116
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
117
|
+
* @param {*} [options] Override http request option.
|
|
118
|
+
* @throws {RequiredError}
|
|
119
|
+
*/
|
|
120
|
+
approveConciergeCandidate: (project_1, platformId_1, conciergeCandidateId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, conciergeCandidateId_1, ...args_1], void 0, function* (project, platformId, conciergeCandidateId, options = {}) {
|
|
121
|
+
// verify required parameter 'project' is not null or undefined
|
|
122
|
+
assertParamExists('approveConciergeCandidate', 'project', project);
|
|
123
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
124
|
+
assertParamExists('approveConciergeCandidate', 'platformId', platformId);
|
|
125
|
+
// verify required parameter 'conciergeCandidateId' is not null or undefined
|
|
126
|
+
assertParamExists('approveConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId);
|
|
127
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}/approve`
|
|
128
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
129
|
+
.replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
|
|
130
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
131
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
132
|
+
let baseOptions;
|
|
133
|
+
if (configuration) {
|
|
134
|
+
baseOptions = configuration.baseOptions;
|
|
135
|
+
}
|
|
136
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
137
|
+
const localVarHeaderParameter = {};
|
|
138
|
+
const localVarQueryParameter = {};
|
|
139
|
+
// authentication session-oauth required
|
|
140
|
+
// oauth required
|
|
141
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
142
|
+
// authentication api-key required
|
|
143
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
144
|
+
if (project !== undefined) {
|
|
145
|
+
localVarQueryParameter['project'] = project;
|
|
146
|
+
}
|
|
147
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
148
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
149
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
150
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
151
|
+
return {
|
|
152
|
+
url: toPathString(localVarUrlObj),
|
|
153
|
+
options: localVarRequestOptions,
|
|
154
|
+
};
|
|
155
|
+
}),
|
|
156
|
+
/**
|
|
157
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
158
|
+
* @summary Delete concierge candidate
|
|
159
|
+
* @param {string} project Project unique identifier
|
|
160
|
+
* @param {string} platformId The platform identifier
|
|
161
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
162
|
+
* @param {*} [options] Override http request option.
|
|
163
|
+
* @throws {RequiredError}
|
|
164
|
+
*/
|
|
165
|
+
deleteConciergeCandidate: (project_1, platformId_1, conciergeCandidateId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, conciergeCandidateId_1, ...args_1], void 0, function* (project, platformId, conciergeCandidateId, options = {}) {
|
|
166
|
+
// verify required parameter 'project' is not null or undefined
|
|
167
|
+
assertParamExists('deleteConciergeCandidate', 'project', project);
|
|
168
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
169
|
+
assertParamExists('deleteConciergeCandidate', 'platformId', platformId);
|
|
170
|
+
// verify required parameter 'conciergeCandidateId' is not null or undefined
|
|
171
|
+
assertParamExists('deleteConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId);
|
|
172
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}`
|
|
173
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
174
|
+
.replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
|
|
175
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
176
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
177
|
+
let baseOptions;
|
|
178
|
+
if (configuration) {
|
|
179
|
+
baseOptions = configuration.baseOptions;
|
|
180
|
+
}
|
|
181
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
|
|
182
|
+
const localVarHeaderParameter = {};
|
|
183
|
+
const localVarQueryParameter = {};
|
|
184
|
+
// authentication session-oauth required
|
|
185
|
+
// oauth required
|
|
186
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
187
|
+
// authentication api-key required
|
|
188
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
189
|
+
if (project !== undefined) {
|
|
190
|
+
localVarQueryParameter['project'] = project;
|
|
191
|
+
}
|
|
192
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
193
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
194
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
195
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
196
|
+
return {
|
|
197
|
+
url: toPathString(localVarUrlObj),
|
|
198
|
+
options: localVarRequestOptions,
|
|
199
|
+
};
|
|
200
|
+
}),
|
|
201
|
+
/**
|
|
202
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
203
|
+
* @summary Get concierge candidate
|
|
204
|
+
* @param {string} project Project unique identifier
|
|
205
|
+
* @param {string} platformId The platform identifier
|
|
206
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
207
|
+
* @param {*} [options] Override http request option.
|
|
208
|
+
* @throws {RequiredError}
|
|
209
|
+
*/
|
|
210
|
+
getConciergeCandidate: (project_1, platformId_1, conciergeCandidateId_1, ...args_1) => __awaiter(this, [project_1, platformId_1, conciergeCandidateId_1, ...args_1], void 0, function* (project, platformId, conciergeCandidateId, options = {}) {
|
|
211
|
+
// verify required parameter 'project' is not null or undefined
|
|
212
|
+
assertParamExists('getConciergeCandidate', 'project', project);
|
|
213
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
214
|
+
assertParamExists('getConciergeCandidate', 'platformId', platformId);
|
|
215
|
+
// verify required parameter 'conciergeCandidateId' is not null or undefined
|
|
216
|
+
assertParamExists('getConciergeCandidate', 'conciergeCandidateId', conciergeCandidateId);
|
|
217
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}`
|
|
218
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
219
|
+
.replace(`{${"conciergeCandidateId"}}`, encodeURIComponent(String(conciergeCandidateId)));
|
|
220
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
221
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
222
|
+
let baseOptions;
|
|
223
|
+
if (configuration) {
|
|
224
|
+
baseOptions = configuration.baseOptions;
|
|
225
|
+
}
|
|
226
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
227
|
+
const localVarHeaderParameter = {};
|
|
228
|
+
const localVarQueryParameter = {};
|
|
229
|
+
// authentication session-oauth required
|
|
230
|
+
// oauth required
|
|
231
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
232
|
+
// authentication api-key required
|
|
233
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
234
|
+
if (project !== undefined) {
|
|
235
|
+
localVarQueryParameter['project'] = project;
|
|
236
|
+
}
|
|
237
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
238
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
239
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
240
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
241
|
+
return {
|
|
242
|
+
url: toPathString(localVarUrlObj),
|
|
243
|
+
options: localVarRequestOptions,
|
|
244
|
+
};
|
|
245
|
+
}),
|
|
246
|
+
/**
|
|
247
|
+
* List concierge candidates
|
|
248
|
+
* @summary List concierge candidates
|
|
249
|
+
* @param {string} project Project unique identifier
|
|
250
|
+
* @param {string} platformId The platform identifier
|
|
251
|
+
* @param {string} [search] Search term to filter results
|
|
252
|
+
* @param {number} [pageToken] Page reference token
|
|
253
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
254
|
+
* @param {*} [options] Override http request option.
|
|
255
|
+
* @throws {RequiredError}
|
|
256
|
+
*/
|
|
257
|
+
listConciergeCandidates: (project_1, platformId_1, search_1, pageToken_1, pageSize_1, ...args_1) => __awaiter(this, [project_1, platformId_1, search_1, pageToken_1, pageSize_1, ...args_1], void 0, function* (project, platformId, search, pageToken, pageSize, options = {}) {
|
|
258
|
+
// verify required parameter 'project' is not null or undefined
|
|
259
|
+
assertParamExists('listConciergeCandidates', 'project', project);
|
|
260
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
261
|
+
assertParamExists('listConciergeCandidates', 'platformId', platformId);
|
|
262
|
+
const localVarPath = `/v1/platform/{platformId}/concierge-candidates`
|
|
263
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
264
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
265
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
266
|
+
let baseOptions;
|
|
267
|
+
if (configuration) {
|
|
268
|
+
baseOptions = configuration.baseOptions;
|
|
269
|
+
}
|
|
270
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
271
|
+
const localVarHeaderParameter = {};
|
|
272
|
+
const localVarQueryParameter = {};
|
|
273
|
+
// authentication session-oauth required
|
|
274
|
+
// oauth required
|
|
275
|
+
yield setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration);
|
|
276
|
+
// authentication api-key required
|
|
277
|
+
yield setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration);
|
|
278
|
+
if (project !== undefined) {
|
|
279
|
+
localVarQueryParameter['project'] = project;
|
|
280
|
+
}
|
|
281
|
+
if (search !== undefined) {
|
|
282
|
+
localVarQueryParameter['search'] = search;
|
|
283
|
+
}
|
|
284
|
+
if (pageToken !== undefined) {
|
|
285
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
286
|
+
}
|
|
287
|
+
if (pageSize !== undefined) {
|
|
288
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
289
|
+
}
|
|
290
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
291
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
292
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
293
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
294
|
+
return {
|
|
295
|
+
url: toPathString(localVarUrlObj),
|
|
296
|
+
options: localVarRequestOptions,
|
|
297
|
+
};
|
|
298
|
+
}),
|
|
299
|
+
};
|
|
300
|
+
};
|
|
301
|
+
/**
|
|
302
|
+
* ConciergeCandidatesApi - functional programming interface
|
|
303
|
+
*/
|
|
304
|
+
export const ConciergeCandidatesApiFp = function (configuration) {
|
|
305
|
+
const localVarAxiosParamCreator = ConciergeCandidatesApiAxiosParamCreator(configuration);
|
|
306
|
+
return {
|
|
307
|
+
/**
|
|
308
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
309
|
+
* @summary Approve concierge candidate
|
|
310
|
+
* @param {string} project Project unique identifier
|
|
311
|
+
* @param {string} platformId The platform identifier
|
|
312
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
313
|
+
* @param {*} [options] Override http request option.
|
|
314
|
+
* @throws {RequiredError}
|
|
315
|
+
*/
|
|
316
|
+
approveConciergeCandidate(project, platformId, conciergeCandidateId, options) {
|
|
317
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
318
|
+
var _a, _b, _c;
|
|
319
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.approveConciergeCandidate(project, platformId, conciergeCandidateId, options);
|
|
320
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
321
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConciergeCandidatesApi.approveConciergeCandidate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
322
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
323
|
+
});
|
|
324
|
+
},
|
|
325
|
+
/**
|
|
326
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
327
|
+
* @summary Delete concierge candidate
|
|
328
|
+
* @param {string} project Project unique identifier
|
|
329
|
+
* @param {string} platformId The platform identifier
|
|
330
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
331
|
+
* @param {*} [options] Override http request option.
|
|
332
|
+
* @throws {RequiredError}
|
|
333
|
+
*/
|
|
334
|
+
deleteConciergeCandidate(project, platformId, conciergeCandidateId, options) {
|
|
335
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
336
|
+
var _a, _b, _c;
|
|
337
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteConciergeCandidate(project, platformId, conciergeCandidateId, options);
|
|
338
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
339
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConciergeCandidatesApi.deleteConciergeCandidate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
340
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
341
|
+
});
|
|
342
|
+
},
|
|
343
|
+
/**
|
|
344
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
345
|
+
* @summary Get concierge candidate
|
|
346
|
+
* @param {string} project Project unique identifier
|
|
347
|
+
* @param {string} platformId The platform identifier
|
|
348
|
+
* @param {string} conciergeCandidateId The concierge candidate identifier
|
|
349
|
+
* @param {*} [options] Override http request option.
|
|
350
|
+
* @throws {RequiredError}
|
|
351
|
+
*/
|
|
352
|
+
getConciergeCandidate(project, platformId, conciergeCandidateId, options) {
|
|
353
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
354
|
+
var _a, _b, _c;
|
|
355
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getConciergeCandidate(project, platformId, conciergeCandidateId, options);
|
|
356
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
357
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConciergeCandidatesApi.getConciergeCandidate']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
358
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
359
|
+
});
|
|
360
|
+
},
|
|
361
|
+
/**
|
|
362
|
+
* List concierge candidates
|
|
363
|
+
* @summary List concierge candidates
|
|
364
|
+
* @param {string} project Project unique identifier
|
|
365
|
+
* @param {string} platformId The platform identifier
|
|
366
|
+
* @param {string} [search] Search term to filter results
|
|
367
|
+
* @param {number} [pageToken] Page reference token
|
|
368
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
369
|
+
* @param {*} [options] Override http request option.
|
|
370
|
+
* @throws {RequiredError}
|
|
371
|
+
*/
|
|
372
|
+
listConciergeCandidates(project, platformId, search, pageToken, pageSize, options) {
|
|
373
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
374
|
+
var _a, _b, _c;
|
|
375
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.listConciergeCandidates(project, platformId, search, pageToken, pageSize, options);
|
|
376
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
377
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ConciergeCandidatesApi.listConciergeCandidates']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
378
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
379
|
+
});
|
|
380
|
+
},
|
|
381
|
+
};
|
|
382
|
+
};
|
|
383
|
+
/**
|
|
384
|
+
* ConciergeCandidatesApi - factory interface
|
|
385
|
+
*/
|
|
386
|
+
export const ConciergeCandidatesApiFactory = function (configuration, basePath, axios) {
|
|
387
|
+
const localVarFp = ConciergeCandidatesApiFp(configuration);
|
|
388
|
+
return {
|
|
389
|
+
/**
|
|
390
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
391
|
+
* @summary Approve concierge candidate
|
|
392
|
+
* @param {ConciergeCandidatesApiApproveConciergeCandidateRequest} requestParameters Request parameters.
|
|
393
|
+
* @param {*} [options] Override http request option.
|
|
394
|
+
* @throws {RequiredError}
|
|
395
|
+
*/
|
|
396
|
+
approveConciergeCandidate(requestParameters, options) {
|
|
397
|
+
return localVarFp.approveConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(axios, basePath));
|
|
398
|
+
},
|
|
399
|
+
/**
|
|
400
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
401
|
+
* @summary Delete concierge candidate
|
|
402
|
+
* @param {ConciergeCandidatesApiDeleteConciergeCandidateRequest} requestParameters Request parameters.
|
|
403
|
+
* @param {*} [options] Override http request option.
|
|
404
|
+
* @throws {RequiredError}
|
|
405
|
+
*/
|
|
406
|
+
deleteConciergeCandidate(requestParameters, options) {
|
|
407
|
+
return localVarFp.deleteConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(axios, basePath));
|
|
408
|
+
},
|
|
409
|
+
/**
|
|
410
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
411
|
+
* @summary Get concierge candidate
|
|
412
|
+
* @param {ConciergeCandidatesApiGetConciergeCandidateRequest} requestParameters Request parameters.
|
|
413
|
+
* @param {*} [options] Override http request option.
|
|
414
|
+
* @throws {RequiredError}
|
|
415
|
+
*/
|
|
416
|
+
getConciergeCandidate(requestParameters, options) {
|
|
417
|
+
return localVarFp.getConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(axios, basePath));
|
|
418
|
+
},
|
|
419
|
+
/**
|
|
420
|
+
* List concierge candidates
|
|
421
|
+
* @summary List concierge candidates
|
|
422
|
+
* @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
|
|
423
|
+
* @param {*} [options] Override http request option.
|
|
424
|
+
* @throws {RequiredError}
|
|
425
|
+
*/
|
|
426
|
+
listConciergeCandidates(requestParameters, options) {
|
|
427
|
+
return localVarFp.listConciergeCandidates(requestParameters.project, requestParameters.platformId, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(axios, basePath));
|
|
428
|
+
},
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
/**
|
|
432
|
+
* ConciergeCandidatesApi - object-oriented interface
|
|
433
|
+
*/
|
|
434
|
+
export class ConciergeCandidatesApi extends BaseAPI {
|
|
435
|
+
/**
|
|
436
|
+
* Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
|
|
437
|
+
* @summary Approve concierge candidate
|
|
438
|
+
* @param {ConciergeCandidatesApiApproveConciergeCandidateRequest} requestParameters Request parameters.
|
|
439
|
+
* @param {*} [options] Override http request option.
|
|
440
|
+
* @throws {RequiredError}
|
|
441
|
+
*/
|
|
442
|
+
approveConciergeCandidate(requestParameters, options) {
|
|
443
|
+
return ConciergeCandidatesApiFp(this.configuration).approveConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(this.axios, this.basePath));
|
|
444
|
+
}
|
|
445
|
+
/**
|
|
446
|
+
* Delete a concierge candidate by a given concierge candidate ID.
|
|
447
|
+
* @summary Delete concierge candidate
|
|
448
|
+
* @param {ConciergeCandidatesApiDeleteConciergeCandidateRequest} requestParameters Request parameters.
|
|
449
|
+
* @param {*} [options] Override http request option.
|
|
450
|
+
* @throws {RequiredError}
|
|
451
|
+
*/
|
|
452
|
+
deleteConciergeCandidate(requestParameters, options) {
|
|
453
|
+
return ConciergeCandidatesApiFp(this.configuration).deleteConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(this.axios, this.basePath));
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* Get a concierge candidate by a given concierge candidate ID.
|
|
457
|
+
* @summary Get concierge candidate
|
|
458
|
+
* @param {ConciergeCandidatesApiGetConciergeCandidateRequest} requestParameters Request parameters.
|
|
459
|
+
* @param {*} [options] Override http request option.
|
|
460
|
+
* @throws {RequiredError}
|
|
461
|
+
*/
|
|
462
|
+
getConciergeCandidate(requestParameters, options) {
|
|
463
|
+
return ConciergeCandidatesApiFp(this.configuration).getConciergeCandidate(requestParameters.project, requestParameters.platformId, requestParameters.conciergeCandidateId, options).then((request) => request(this.axios, this.basePath));
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* List concierge candidates
|
|
467
|
+
* @summary List concierge candidates
|
|
468
|
+
* @param {ConciergeCandidatesApiListConciergeCandidatesRequest} requestParameters Request parameters.
|
|
469
|
+
* @param {*} [options] Override http request option.
|
|
470
|
+
* @throws {RequiredError}
|
|
471
|
+
*/
|
|
472
|
+
listConciergeCandidates(requestParameters, options) {
|
|
473
|
+
return ConciergeCandidatesApiFp(this.configuration).listConciergeCandidates(requestParameters.project, requestParameters.platformId, requestParameters.search, requestParameters.pageToken, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
|
|
474
|
+
}
|
|
475
|
+
}
|
|
100
476
|
/**
|
|
101
477
|
* CustomersApi - axios parameter creator
|
|
102
478
|
*/
|
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
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# ConciergeCandidate
|
|
2
|
+
|
|
3
|
+
A concierge candidate. This is a potentially high value person who has interacted with the platform in some way.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique object identifier | [default to undefined]
|
|
10
|
+
**firstName** | **string** | The first name of the concierge candidate | [default to undefined]
|
|
11
|
+
**lastName** | **string** | The last name of the concierge candidate | [default to undefined]
|
|
12
|
+
**email** | **string** | The email of the concierge candidate | [default to undefined]
|
|
13
|
+
**source** | [**ConciergeCandidateSource**](ConciergeCandidateSource.md) | | [default to undefined]
|
|
14
|
+
**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
15
|
+
**approvedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
16
|
+
**completedAt** | **string** | ISO 8601 Timestamp | [default to undefined]
|
|
17
|
+
**clientRef** | **string** | A reference to the project being ordered | [default to undefined]
|
|
18
|
+
**originRef** | **string** | A reference to the origin of the concierge candidate. The structure of the origin ref can be inferred from the concierge candidate source. | [default to undefined]
|
|
19
|
+
**taskRef** | **string** | Reference to the task resource | [optional] [default to undefined]
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import { ConciergeCandidate } from '@teemill/platform';
|
|
25
|
+
|
|
26
|
+
const instance: ConciergeCandidate = {
|
|
27
|
+
id,
|
|
28
|
+
firstName,
|
|
29
|
+
lastName,
|
|
30
|
+
email,
|
|
31
|
+
source,
|
|
32
|
+
createdAt,
|
|
33
|
+
approvedAt,
|
|
34
|
+
completedAt,
|
|
35
|
+
clientRef,
|
|
36
|
+
originRef,
|
|
37
|
+
taskRef,
|
|
38
|
+
};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ConciergeCandidateSource
|
|
2
|
+
|
|
3
|
+
The source of the concierge candidate. This is the channel through which the concierge candidate interacted with the platform.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**type** | **string** | The type of the source | [default to undefined]
|
|
10
|
+
**name** | **string** | The name of the source | [default to undefined]
|
|
11
|
+
**description** | **string** | The description of the source | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ConciergeCandidateSource } from '@teemill/platform';
|
|
17
|
+
|
|
18
|
+
const instance: ConciergeCandidateSource = {
|
|
19
|
+
type,
|
|
20
|
+
name,
|
|
21
|
+
description,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|