@teemill/platform 0.65.2 → 0.66.0

package/dist/esm/index.d.ts

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

package/dist/esm/index.js

@@ -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.66.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/index.d.ts

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

package/dist/index.js

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

package/docs/ConciergeCandidate.md

@@ -0,0 +1,39 @@
+# ConciergeCandidate
+
+A concierge candidate. This is a potentially high value person who has interacted with the platform in some way.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [default to undefined]
+**firstName** | **string** | The first name of the concierge candidate | [default to undefined]
+**lastName** | **string** | The last name of the concierge candidate | [default to undefined]
+**email** | **string** | The email of the concierge candidate | [default to undefined]
+**source** | [**ConciergeCandidateSource**](ConciergeCandidateSource.md) |  | [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [default to undefined]
+**dismissedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**clientRef** | **string** | A reference to the project being ordered | [default to undefined]
+**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]
+**assignedUserRef** | **string** | Reference to the user resource | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ConciergeCandidate } from '@teemill/platform';
+
+const instance: ConciergeCandidate = {
+    id,
+    firstName,
+    lastName,
+    email,
+    source,
+    createdAt,
+    dismissedAt,
+    clientRef,
+    originRef,
+    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/docs/ConciergeCandidateSource.md

@@ -0,0 +1,25 @@
+# ConciergeCandidateSource
+
+The source of the concierge candidate. This is the channel through which the concierge candidate interacted with the platform.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** | The type of the source | [default to undefined]
+**name** | **string** | The name of the source | [default to undefined]
+**description** | **string** | The description of the source | [default to undefined]
+
+## Example
+
+```typescript
+import { ConciergeCandidateSource } from '@teemill/platform';
+
+const instance: ConciergeCandidateSource = {
+    type,
+    name,
+    description,
+};
+```
+
+[[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/ConciergeCandidatesApi.md

@@ -0,0 +1,197 @@
+# ConciergeCandidatesApi
+
+All URIs are relative to *https://localhost:8080*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getConciergeCandidate**](#getconciergecandidate) | **GET** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Get concierge candidate|
+|[**listConciergeCandidates**](#listconciergecandidates) | **GET** /v1/platform/{platformId}/concierge-candidates | List concierge candidates|
+|[**updateConciergeCandidate**](#updateconciergecandidate) | **PATCH** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Update concierge candidate|
+
+# **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)
+
+const { status, data } = await apiInstance.listConciergeCandidates(
+    project,
+    platformId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **project** | [**string**] | Project unique identifier | defaults to undefined|
+| **platformId** | [**string**] | The platform identifier | defaults to undefined|
+
+
+### 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)
+
+# **updateConciergeCandidate**
+> ConciergeCandidate updateConciergeCandidate(updateConciergeCandidateRequest)
+
+Update a concierge candidate by a given concierge candidate ID.
+
+### Example
+
+```typescript
+import {
+    ConciergeCandidatesApi,
+    Configuration,
+    UpdateConciergeCandidateRequest
+} 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)
+let updateConciergeCandidateRequest: UpdateConciergeCandidateRequest; //
+
+const { status, data } = await apiInstance.updateConciergeCandidate(
+    project,
+    platformId,
+    conciergeCandidateId,
+    updateConciergeCandidateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **updateConciergeCandidateRequest** | **UpdateConciergeCandidateRequest**|  | |
+| **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**: application/json
+ - **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)
+

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.66.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.66.0",
   "description": "OpenAPI client for @teemill/platform",
   "author": "OpenAPI-Generator Contributors",
   "repository": {