@teemill/platform 0.66.0 → 0.67.1

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.
@@ -4,14 +4,15 @@ All URIs are relative to *https://localhost:8080*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**approveConciergeCandidate**](#approveconciergecandidate) | **POST** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId}/approve | Approve concierge candidate|
8
+ |[**deleteConciergeCandidate**](#deleteconciergecandidate) | **DELETE** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Delete concierge candidate|
7
9
  |[**getConciergeCandidate**](#getconciergecandidate) | **GET** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Get concierge candidate|
8
10
  |[**listConciergeCandidates**](#listconciergecandidates) | **GET** /v1/platform/{platformId}/concierge-candidates | List concierge candidates|
9
- |[**updateConciergeCandidate**](#updateconciergecandidate) | **PATCH** /v1/platform/{platformId}/concierge-candidates/{conciergeCandidateId} | Update concierge candidate|
10
11
 
11
- # **getConciergeCandidate**
12
- > ConciergeCandidate getConciergeCandidate()
12
+ # **approveConciergeCandidate**
13
+ > ConciergeCandidate approveConciergeCandidate()
13
14
 
14
- Get a concierge candidate by a given concierge candidate ID.
15
+ Approve a concierge candidate by a given concierge candidate ID. This will create a task with #concierge tag that can be assigned to a user.
15
16
 
16
17
  ### Example
17
18
 
@@ -28,7 +29,7 @@ let project: string; //Project unique identifier (default to undefined)
28
29
  let platformId: string; //The platform identifier (default to undefined)
29
30
  let conciergeCandidateId: string; //The concierge candidate identifier (default to undefined)
30
31
 
31
- const { status, data } = await apiInstance.getConciergeCandidate(
32
+ const { status, data } = await apiInstance.approveConciergeCandidate(
32
33
  project,
33
34
  platformId,
34
35
  conciergeCandidateId
@@ -70,10 +71,10 @@ const { status, data } = await apiInstance.getConciergeCandidate(
70
71
 
71
72
  [[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)
72
73
 
73
- # **listConciergeCandidates**
74
- > ListConciergeCandidates200Response listConciergeCandidates()
74
+ # **deleteConciergeCandidate**
75
+ > deleteConciergeCandidate()
75
76
 
76
- List concierge candidates
77
+ Delete a concierge candidate by a given concierge candidate ID.
77
78
 
78
79
  ### Example
79
80
 
@@ -88,10 +89,12 @@ const apiInstance = new ConciergeCandidatesApi(configuration);
88
89
 
89
90
  let project: string; //Project unique identifier (default to undefined)
90
91
  let platformId: string; //The platform identifier (default to undefined)
92
+ let conciergeCandidateId: string; //The concierge candidate identifier (default to undefined)
91
93
 
92
- const { status, data } = await apiInstance.listConciergeCandidates(
94
+ const { status, data } = await apiInstance.deleteConciergeCandidate(
93
95
  project,
94
- platformId
96
+ platformId,
97
+ conciergeCandidateId
95
98
  );
96
99
  ```
97
100
 
@@ -101,11 +104,12 @@ const { status, data } = await apiInstance.listConciergeCandidates(
101
104
  |------------- | ------------- | ------------- | -------------|
102
105
  | **project** | [**string**] | Project unique identifier | defaults to undefined|
103
106
  | **platformId** | [**string**] | The platform identifier | defaults to undefined|
107
+ | **conciergeCandidateId** | [**string**] | The concierge candidate identifier | defaults to undefined|
104
108
 
105
109
 
106
110
  ### Return type
107
111
 
108
- **ListConciergeCandidates200Response**
112
+ void (empty response body)
109
113
 
110
114
  ### Authorization
111
115
 
@@ -120,7 +124,7 @@ const { status, data } = await apiInstance.listConciergeCandidates(
120
124
  ### HTTP response details
121
125
  | Status code | Description | Response headers |
122
126
  |-------------|-------------|------------------|
123
- |**200** | Concierge candidates | - |
127
+ |**204** | Concierge candidate deleted | - |
124
128
  |**400** | Failed validation | - |
125
129
  |**401** | Not authorised to access this resource | - |
126
130
  |**403** | Refuse to authorize | - |
@@ -129,18 +133,17 @@ const { status, data } = await apiInstance.listConciergeCandidates(
129
133
 
130
134
  [[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)
131
135
 
132
- # **updateConciergeCandidate**
133
- > ConciergeCandidate updateConciergeCandidate(updateConciergeCandidateRequest)
136
+ # **getConciergeCandidate**
137
+ > ConciergeCandidate getConciergeCandidate()
134
138
 
135
- Update a concierge candidate by a given concierge candidate ID.
139
+ Get a concierge candidate by a given concierge candidate ID.
136
140
 
137
141
  ### Example
138
142
 
139
143
  ```typescript
140
144
  import {
141
145
  ConciergeCandidatesApi,
142
- Configuration,
143
- UpdateConciergeCandidateRequest
146
+ Configuration
144
147
  } from '@teemill/platform';
145
148
 
146
149
  const configuration = new Configuration();
@@ -149,13 +152,11 @@ const apiInstance = new ConciergeCandidatesApi(configuration);
149
152
  let project: string; //Project unique identifier (default to undefined)
150
153
  let platformId: string; //The platform identifier (default to undefined)
151
154
  let conciergeCandidateId: string; //The concierge candidate identifier (default to undefined)
152
- let updateConciergeCandidateRequest: UpdateConciergeCandidateRequest; //
153
155
 
154
- const { status, data } = await apiInstance.updateConciergeCandidate(
156
+ const { status, data } = await apiInstance.getConciergeCandidate(
155
157
  project,
156
158
  platformId,
157
- conciergeCandidateId,
158
- updateConciergeCandidateRequest
159
+ conciergeCandidateId
159
160
  );
160
161
  ```
161
162
 
@@ -163,7 +164,6 @@ const { status, data } = await apiInstance.updateConciergeCandidate(
163
164
 
164
165
  |Name | Type | Description | Notes|
165
166
  |------------- | ------------- | ------------- | -------------|
166
- | **updateConciergeCandidateRequest** | **UpdateConciergeCandidateRequest**| | |
167
167
  | **project** | [**string**] | Project unique identifier | defaults to undefined|
168
168
  | **platformId** | [**string**] | The platform identifier | defaults to undefined|
169
169
  | **conciergeCandidateId** | [**string**] | The concierge candidate identifier | defaults to undefined|
@@ -179,7 +179,7 @@ const { status, data } = await apiInstance.updateConciergeCandidate(
179
179
 
180
180
  ### HTTP request headers
181
181
 
182
- - **Content-Type**: application/json
182
+ - **Content-Type**: Not defined
183
183
  - **Accept**: application/json
184
184
 
185
185
 
@@ -195,3 +195,71 @@ const { status, data } = await apiInstance.updateConciergeCandidate(
195
195
 
196
196
  [[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)
197
197
 
198
+ # **listConciergeCandidates**
199
+ > ListConciergeCandidates200Response listConciergeCandidates()
200
+
201
+ List concierge candidates
202
+
203
+ ### Example
204
+
205
+ ```typescript
206
+ import {
207
+ ConciergeCandidatesApi,
208
+ Configuration
209
+ } from '@teemill/platform';
210
+
211
+ const configuration = new Configuration();
212
+ const apiInstance = new ConciergeCandidatesApi(configuration);
213
+
214
+ let project: string; //Project unique identifier (default to undefined)
215
+ let platformId: string; //The platform identifier (default to undefined)
216
+ let search: string; //Search term to filter results (optional) (default to undefined)
217
+ let pageToken: number; //Page reference token (optional) (default to 1)
218
+ 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)
219
+
220
+ const { status, data } = await apiInstance.listConciergeCandidates(
221
+ project,
222
+ platformId,
223
+ search,
224
+ pageToken,
225
+ pageSize
226
+ );
227
+ ```
228
+
229
+ ### Parameters
230
+
231
+ |Name | Type | Description | Notes|
232
+ |------------- | ------------- | ------------- | -------------|
233
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
234
+ | **platformId** | [**string**] | The platform identifier | defaults to undefined|
235
+ | **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
236
+ | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
237
+ | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
238
+
239
+
240
+ ### Return type
241
+
242
+ **ListConciergeCandidates200Response**
243
+
244
+ ### Authorization
245
+
246
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
247
+
248
+ ### HTTP request headers
249
+
250
+ - **Content-Type**: Not defined
251
+ - **Accept**: application/json
252
+
253
+
254
+ ### HTTP response details
255
+ | Status code | Description | Response headers |
256
+ |-------------|-------------|------------------|
257
+ |**200** | Concierge candidates | - |
258
+ |**400** | Failed validation | - |
259
+ |**401** | Not authorised to access this resource | - |
260
+ |**403** | Refuse to authorize | - |
261
+ |**404** | Resource not found | - |
262
+ |**500** | Unknown server error | - |
263
+
264
+ [[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)
265
+
package/index.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.66.0
7
+ * The version of the OpenAPI document: 0.67.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/platform",
3
- "version": "0.66.0",
3
+ "version": "0.67.1",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {