@teemill/platform 0.65.2 → 0.67.0

package/docs/ConciergeCandidatesApi.md

@@ -0,0 +1,265 @@
+# ConciergeCandidatesApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**approveConciergeCandidate**](#approveconciergecandidate) | **POST** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}/approve | Approve concierge candidate|
+|[**deleteConciergeCandidate**](#deleteconciergecandidate) | **DELETE** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Delete concierge candidate|
+|[**getConciergeCandidate**](#getconciergecandidate) | **GET** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Get concierge candidate|
+|[**listConciergeCandidates**](#listconciergecandidates) | **GET** /v1/platform/{platformId}/concierge-candidates | List concierge candidates|
+
+# **approveConciergeCandidate**
+> ConciergeCandidate approveConciergeCandidate()
+
+Approve a concierge candidate by a given concierge candidate ID. This will create a task that cann be assigned to a user.
+
+### Example
+
+```typescript
+import {
+    ConciergeCandidatesApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ConciergeCandidatesApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let conciergeCandidateId: string; //The concierge candidate identifier (default to undefined)
+
+const { status, data } = await apiInstance.approveConciergeCandidate(
+    project,
+    platformId,
+    conciergeCandidateId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **conciergeCandidateId** | [**string**] | The concierge candidate identifier | defaults to undefined|
+
+
+### Return type
+
+**ConciergeCandidate**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Concierge candidate |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteConciergeCandidate**
+> deleteConciergeCandidate()
+
+Delete a concierge candidate by a given concierge candidate ID.
+
+### Example
+
+```typescript
+import {
+    ConciergeCandidatesApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ConciergeCandidatesApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let conciergeCandidateId: string; //The concierge candidate identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteConciergeCandidate(
+    project,
+    platformId,
+    conciergeCandidateId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **conciergeCandidateId** | [**string**] | The concierge candidate identifier | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Concierge candidate deleted |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getConciergeCandidate**
+> ConciergeCandidate getConciergeCandidate()
+
+Get a concierge candidate by a given concierge candidate ID.
+
+### Example
+
+```typescript
+import {
+    ConciergeCandidatesApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ConciergeCandidatesApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let conciergeCandidateId: string; //The concierge candidate identifier (default to undefined)
+
+const { status, data } = await apiInstance.getConciergeCandidate(
+    project,
+    platformId,
+    conciergeCandidateId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **conciergeCandidateId** | [**string**] | The concierge candidate identifier | defaults to undefined|
+
+
+### Return type
+
+**ConciergeCandidate**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Concierge candidate |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **listConciergeCandidates**
+> ListConciergeCandidates200Response listConciergeCandidates()
+
+List concierge candidates
+
+### Example
+
+```typescript
+import {
+    ConciergeCandidatesApi,
+    Configuration
+} from '@teemill/platform';
+
+const configuration = new Configuration();
+const apiInstance = new ConciergeCandidatesApi(configuration);
+
+let project: string; //Project unique identifier (default to undefined)
+let platformId: string; //The platform identifier (default to undefined)
+let search: string; //Search term to filter results (optional) (default to undefined)
+let pageToken: number; //Page reference token (optional) (default to 1)
+let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
+
+const { status, data } = await apiInstance.listConciergeCandidates(
+    project,
+    platformId,
+    search,
+    pageToken,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
+| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
+| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
+
+
+### Return type
+
+**ListConciergeCandidates200Response**
+
+### Authorization
+
+[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Concierge candidates |  -  |
+|**400** | Failed validation |  -  |
+|**401** | Not authorised to access this resource |  -  |
+|**403** | Refuse to authorize |  -  |
+|**404** | Resource not found |  -  |
+|**500** | Unknown server error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/ListConciergeCandidates200Response.md

@@ -0,0 +1,22 @@
+# ListConciergeCandidates200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**candidates** | [**Array<ConciergeCandidate>**](ConciergeCandidate.md) |  | [default to undefined]
+**nextPageToken** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ListConciergeCandidates200Response } from '@teemill/platform';
+
+const instance: ListConciergeCandidates200Response = {
+    candidates,
+    nextPageToken,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UpdateConciergeCandidateRequest.md

@@ -0,0 +1,22 @@
+# UpdateConciergeCandidateRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dismiss** | **boolean** | Whether the concierge candidate has been dismissed or not. | [optional] [default to undefined]
+**assignedUserRef** | **string** | Reference to the user resource | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UpdateConciergeCandidateRequest } from '@teemill/platform';
+
+const instance: UpdateConciergeCandidateRequest = {
+    dismiss,
+    assignedUserRef,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

@@ -4,7 +4,7 @@
  * Platform
  * Manage Your podOS platform
  *
- * The version of the OpenAPI document: 0.65.2
+ * The version of the OpenAPI document: 0.67.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teemill/platform",
-  "version": "0.65.2",
+  "version": "0.67.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {