@gewis/grooster-backend-ts 1.1.0 → 1.2.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.
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +0 -1
- package/src/api.ts +2118 -3096
- package/src/base.ts +28 -33
- package/src/common.ts +76 -128
- package/src/configuration.ts +95 -117
- package/src/docs/AuthApi.md +45 -33
- package/src/docs/GormDeletedAt.md +8 -7
- package/src/docs/Organ.md +15 -15
- package/src/docs/Roster.md +28 -27
- package/src/docs/RosterAnswer.md +20 -19
- package/src/docs/RosterAnswerApi.md +45 -37
- package/src/docs/RosterAnswerCreateRequest.md +12 -11
- package/src/docs/RosterAnswerUpdateRequest.md +6 -5
- package/src/docs/RosterApi.md +188 -128
- package/src/docs/RosterCreateRequest.md +12 -11
- package/src/docs/RosterShift.md +16 -15
- package/src/docs/RosterShiftApi.md +43 -29
- package/src/docs/RosterShiftCreateRequest.md +8 -7
- package/src/docs/RosterTemplate.md +18 -15
- package/src/docs/RosterTemplateCreateRequest.md +10 -7
- package/src/docs/RosterUpdateRequest.md +8 -7
- package/src/docs/SavedShift.md +20 -19
- package/src/docs/SavedShiftApi.md +69 -48
- package/src/docs/SavedShiftUpdateRequest.md +6 -5
- package/src/docs/User.md +18 -17
- package/src/docs/UserApi.md +82 -58
- package/src/docs/UserCreateRequest.md +10 -9
- package/src/index.ts +4 -2
package/src/docs/RosterApi.md
CHANGED
|
@@ -1,41 +1,48 @@
|
|
|
1
1
|
# RosterApi
|
|
2
2
|
|
|
3
|
-
All URIs are relative to
|
|
4
|
-
|
|
5
|
-
|
|
|
6
|
-
|
|
7
|
-
|
|
|
8
|
-
|
|
|
9
|
-
|
|
|
10
|
-
|
|
|
11
|
-
|
|
|
12
|
-
|
|
|
13
|
-
|
|
|
14
|
-
|
|
|
15
|
-
|
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createRoster**](#createroster) | **POST** /roster | CreateRoster a new roster|
|
|
8
|
+
|[**createRosterTemplate**](#createrostertemplate) | **POST** /roster/template | Creates a template of a roster by defining the name of the shifts|
|
|
9
|
+
|[**deleteRoster**](#deleteroster) | **DELETE** /roster/{id} | DeleteRoster a roster|
|
|
10
|
+
|[**deleteRosterTemplate**](#deleterostertemplate) | **DELETE** /roster/template/{id} | Deletes a roster template by ID|
|
|
11
|
+
|[**getRoster**](#getroster) | **GET** /roster/{id} | Get a specific roster by id|
|
|
12
|
+
|[**getRosterTemplate**](#getrostertemplate) | **GET** /roster/template/{id} | Get a roster template by ID|
|
|
13
|
+
|[**getRosterTemplates**](#getrostertemplates) | **GET** /roster/template | Get all rosters templates or query by organ ID|
|
|
14
|
+
|[**getRosters**](#getrosters) | **GET** /roster | Get all rosters or query by date and organ|
|
|
15
|
+
|[**updateRoster**](#updateroster) | **PATCH** /roster/{id} | Update a roster|
|
|
16
16
|
|
|
17
17
|
# **createRoster**
|
|
18
|
-
|
|
19
18
|
> Roster createRoster(createParams)
|
|
20
19
|
|
|
20
|
+
|
|
21
21
|
### Example
|
|
22
22
|
|
|
23
23
|
```typescript
|
|
24
|
-
import {
|
|
24
|
+
import {
|
|
25
|
+
RosterApi,
|
|
26
|
+
Configuration,
|
|
27
|
+
RosterCreateRequest
|
|
28
|
+
} from './api';
|
|
25
29
|
|
|
26
30
|
const configuration = new Configuration();
|
|
27
31
|
const apiInstance = new RosterApi(configuration);
|
|
28
32
|
|
|
29
33
|
let createParams: RosterCreateRequest; //Roster input
|
|
30
34
|
|
|
31
|
-
const { status, data } = await apiInstance.createRoster(
|
|
35
|
+
const { status, data } = await apiInstance.createRoster(
|
|
36
|
+
createParams
|
|
37
|
+
);
|
|
32
38
|
```
|
|
33
39
|
|
|
34
40
|
### Parameters
|
|
35
41
|
|
|
36
|
-
|
|
|
37
|
-
|
|
38
|
-
| **createParams** | **RosterCreateRequest
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **createParams** | **RosterCreateRequest**| Roster input | |
|
|
45
|
+
|
|
39
46
|
|
|
40
47
|
### Return type
|
|
41
48
|
|
|
@@ -47,40 +54,47 @@ const { status, data } = await apiInstance.createRoster(createParams);
|
|
|
47
54
|
|
|
48
55
|
### HTTP request headers
|
|
49
56
|
|
|
50
|
-
- **Content-Type**: application/json
|
|
51
|
-
- **Accept**: application/json
|
|
57
|
+
- **Content-Type**: application/json
|
|
58
|
+
- **Accept**: application/json
|
|
52
59
|
|
|
53
|
-
### HTTP response details
|
|
54
60
|
|
|
61
|
+
### HTTP response details
|
|
55
62
|
| Status code | Description | Response headers |
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**200** | OK | - |
|
|
65
|
+
|**400** | Bad Request | - |
|
|
59
66
|
|
|
60
67
|
[[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)
|
|
61
68
|
|
|
62
69
|
# **createRosterTemplate**
|
|
63
|
-
|
|
64
70
|
> Array<SavedShift> createRosterTemplate()
|
|
65
71
|
|
|
72
|
+
|
|
66
73
|
### Example
|
|
67
74
|
|
|
68
75
|
```typescript
|
|
69
|
-
import {
|
|
76
|
+
import {
|
|
77
|
+
RosterApi,
|
|
78
|
+
Configuration,
|
|
79
|
+
RosterTemplateCreateRequest
|
|
80
|
+
} from './api';
|
|
70
81
|
|
|
71
82
|
const configuration = new Configuration();
|
|
72
83
|
const apiInstance = new RosterApi(configuration);
|
|
73
84
|
|
|
74
85
|
let params: RosterTemplateCreateRequest; //Template Params (optional)
|
|
75
86
|
|
|
76
|
-
const { status, data } = await apiInstance.createRosterTemplate(
|
|
87
|
+
const { status, data } = await apiInstance.createRosterTemplate(
|
|
88
|
+
params
|
|
89
|
+
);
|
|
77
90
|
```
|
|
78
91
|
|
|
79
92
|
### Parameters
|
|
80
93
|
|
|
81
|
-
|
|
|
82
|
-
|
|
83
|
-
| **params** | **RosterTemplateCreateRequest
|
|
94
|
+
|Name | Type | Description | Notes|
|
|
95
|
+
|------------- | ------------- | ------------- | -------------|
|
|
96
|
+
| **params** | **RosterTemplateCreateRequest**| Template Params | |
|
|
97
|
+
|
|
84
98
|
|
|
85
99
|
### Return type
|
|
86
100
|
|
|
@@ -92,40 +106,46 @@ const { status, data } = await apiInstance.createRosterTemplate(params);
|
|
|
92
106
|
|
|
93
107
|
### HTTP request headers
|
|
94
108
|
|
|
95
|
-
- **Content-Type**: application/json
|
|
96
|
-
- **Accept**: application/json
|
|
109
|
+
- **Content-Type**: application/json
|
|
110
|
+
- **Accept**: application/json
|
|
97
111
|
|
|
98
|
-
### HTTP response details
|
|
99
112
|
|
|
100
|
-
|
|
101
|
-
|
|
|
102
|
-
|
|
103
|
-
|
|
113
|
+
### HTTP response details
|
|
114
|
+
| Status code | Description | Response headers |
|
|
115
|
+
|-------------|-------------|------------------|
|
|
116
|
+
|**200** | Created Template | - |
|
|
117
|
+
|**400** | Invalid request | - |
|
|
104
118
|
|
|
105
119
|
[[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)
|
|
106
120
|
|
|
107
121
|
# **deleteRoster**
|
|
108
|
-
|
|
109
122
|
> string deleteRoster()
|
|
110
123
|
|
|
124
|
+
|
|
111
125
|
### Example
|
|
112
126
|
|
|
113
127
|
```typescript
|
|
114
|
-
import {
|
|
128
|
+
import {
|
|
129
|
+
RosterApi,
|
|
130
|
+
Configuration
|
|
131
|
+
} from './api';
|
|
115
132
|
|
|
116
133
|
const configuration = new Configuration();
|
|
117
134
|
const apiInstance = new RosterApi(configuration);
|
|
118
135
|
|
|
119
136
|
let id: number; //Roster ID (default to undefined)
|
|
120
137
|
|
|
121
|
-
const { status, data } = await apiInstance.deleteRoster(
|
|
138
|
+
const { status, data } = await apiInstance.deleteRoster(
|
|
139
|
+
id
|
|
140
|
+
);
|
|
122
141
|
```
|
|
123
142
|
|
|
124
143
|
### Parameters
|
|
125
144
|
|
|
126
|
-
|
|
|
127
|
-
|
|
128
|
-
| **id** | [**number**] | Roster ID
|
|
145
|
+
|Name | Type | Description | Notes|
|
|
146
|
+
|------------- | ------------- | ------------- | -------------|
|
|
147
|
+
| **id** | [**number**] | Roster ID | defaults to undefined|
|
|
148
|
+
|
|
129
149
|
|
|
130
150
|
### Return type
|
|
131
151
|
|
|
@@ -137,41 +157,47 @@ const { status, data } = await apiInstance.deleteRoster(id);
|
|
|
137
157
|
|
|
138
158
|
### HTTP request headers
|
|
139
159
|
|
|
140
|
-
- **Content-Type**: Not defined
|
|
141
|
-
- **Accept**: application/json
|
|
160
|
+
- **Content-Type**: Not defined
|
|
161
|
+
- **Accept**: application/json
|
|
142
162
|
|
|
143
|
-
### HTTP response details
|
|
144
163
|
|
|
164
|
+
### HTTP response details
|
|
145
165
|
| Status code | Description | Response headers |
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
166
|
+
|-------------|-------------|------------------|
|
|
167
|
+
|**200** | OK | - |
|
|
168
|
+
|**400** | Bad Request | - |
|
|
169
|
+
|**404** | Not Found | - |
|
|
150
170
|
|
|
151
171
|
[[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)
|
|
152
172
|
|
|
153
173
|
# **deleteRosterTemplate**
|
|
154
|
-
|
|
155
174
|
> string deleteRosterTemplate()
|
|
156
175
|
|
|
176
|
+
|
|
157
177
|
### Example
|
|
158
178
|
|
|
159
179
|
```typescript
|
|
160
|
-
import {
|
|
180
|
+
import {
|
|
181
|
+
RosterApi,
|
|
182
|
+
Configuration
|
|
183
|
+
} from './api';
|
|
161
184
|
|
|
162
185
|
const configuration = new Configuration();
|
|
163
186
|
const apiInstance = new RosterApi(configuration);
|
|
164
187
|
|
|
165
188
|
let id: number; //Template ID (default to undefined)
|
|
166
189
|
|
|
167
|
-
const { status, data } = await apiInstance.deleteRosterTemplate(
|
|
190
|
+
const { status, data } = await apiInstance.deleteRosterTemplate(
|
|
191
|
+
id
|
|
192
|
+
);
|
|
168
193
|
```
|
|
169
194
|
|
|
170
195
|
### Parameters
|
|
171
196
|
|
|
172
|
-
|
|
|
173
|
-
|
|
174
|
-
| **id** | [**number**] | Template ID | defaults to undefined
|
|
197
|
+
|Name | Type | Description | Notes|
|
|
198
|
+
|------------- | ------------- | ------------- | -------------|
|
|
199
|
+
| **id** | [**number**] | Template ID | defaults to undefined|
|
|
200
|
+
|
|
175
201
|
|
|
176
202
|
### Return type
|
|
177
203
|
|
|
@@ -183,41 +209,47 @@ const { status, data } = await apiInstance.deleteRosterTemplate(id);
|
|
|
183
209
|
|
|
184
210
|
### HTTP request headers
|
|
185
211
|
|
|
186
|
-
- **Content-Type**: Not defined
|
|
187
|
-
- **Accept**: application/json
|
|
212
|
+
- **Content-Type**: Not defined
|
|
213
|
+
- **Accept**: application/json
|
|
188
214
|
|
|
189
|
-
### HTTP response details
|
|
190
215
|
|
|
216
|
+
### HTTP response details
|
|
191
217
|
| Status code | Description | Response headers |
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
218
|
+
|-------------|-------------|------------------|
|
|
219
|
+
|**200** | OK | - |
|
|
220
|
+
|**400** | Bad Request | - |
|
|
221
|
+
|**404** | Not Found | - |
|
|
196
222
|
|
|
197
223
|
[[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)
|
|
198
224
|
|
|
199
225
|
# **getRoster**
|
|
200
|
-
|
|
201
226
|
> Roster getRoster()
|
|
202
227
|
|
|
228
|
+
|
|
203
229
|
### Example
|
|
204
230
|
|
|
205
231
|
```typescript
|
|
206
|
-
import {
|
|
232
|
+
import {
|
|
233
|
+
RosterApi,
|
|
234
|
+
Configuration
|
|
235
|
+
} from './api';
|
|
207
236
|
|
|
208
237
|
const configuration = new Configuration();
|
|
209
238
|
const apiInstance = new RosterApi(configuration);
|
|
210
239
|
|
|
211
240
|
let id: number; //Roster ID (default to undefined)
|
|
212
241
|
|
|
213
|
-
const { status, data } = await apiInstance.getRoster(
|
|
242
|
+
const { status, data } = await apiInstance.getRoster(
|
|
243
|
+
id
|
|
244
|
+
);
|
|
214
245
|
```
|
|
215
246
|
|
|
216
247
|
### Parameters
|
|
217
248
|
|
|
218
|
-
|
|
|
219
|
-
|
|
220
|
-
| **id** | [**number**] | Roster ID
|
|
249
|
+
|Name | Type | Description | Notes|
|
|
250
|
+
|------------- | ------------- | ------------- | -------------|
|
|
251
|
+
| **id** | [**number**] | Roster ID | defaults to undefined|
|
|
252
|
+
|
|
221
253
|
|
|
222
254
|
### Return type
|
|
223
255
|
|
|
@@ -229,41 +261,47 @@ const { status, data } = await apiInstance.getRoster(id);
|
|
|
229
261
|
|
|
230
262
|
### HTTP request headers
|
|
231
263
|
|
|
232
|
-
- **Content-Type**: Not defined
|
|
233
|
-
- **Accept**: application/json
|
|
264
|
+
- **Content-Type**: Not defined
|
|
265
|
+
- **Accept**: application/json
|
|
234
266
|
|
|
235
|
-
### HTTP response details
|
|
236
267
|
|
|
268
|
+
### HTTP response details
|
|
237
269
|
| Status code | Description | Response headers |
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
270
|
+
|-------------|-------------|------------------|
|
|
271
|
+
|**200** | OK | - |
|
|
272
|
+
|**400** | Bad Request | - |
|
|
273
|
+
|**404** | Not Found | - |
|
|
242
274
|
|
|
243
275
|
[[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)
|
|
244
276
|
|
|
245
277
|
# **getRosterTemplate**
|
|
246
|
-
|
|
247
278
|
> RosterTemplate getRosterTemplate()
|
|
248
279
|
|
|
280
|
+
|
|
249
281
|
### Example
|
|
250
282
|
|
|
251
283
|
```typescript
|
|
252
|
-
import {
|
|
284
|
+
import {
|
|
285
|
+
RosterApi,
|
|
286
|
+
Configuration
|
|
287
|
+
} from './api';
|
|
253
288
|
|
|
254
289
|
const configuration = new Configuration();
|
|
255
290
|
const apiInstance = new RosterApi(configuration);
|
|
256
291
|
|
|
257
292
|
let id: number; //Template ID (default to undefined)
|
|
258
293
|
|
|
259
|
-
const { status, data } = await apiInstance.getRosterTemplate(
|
|
294
|
+
const { status, data } = await apiInstance.getRosterTemplate(
|
|
295
|
+
id
|
|
296
|
+
);
|
|
260
297
|
```
|
|
261
298
|
|
|
262
299
|
### Parameters
|
|
263
300
|
|
|
264
|
-
|
|
|
265
|
-
|
|
266
|
-
| **id** | [**number**] | Template ID | defaults to undefined
|
|
301
|
+
|Name | Type | Description | Notes|
|
|
302
|
+
|------------- | ------------- | ------------- | -------------|
|
|
303
|
+
| **id** | [**number**] | Template ID | defaults to undefined|
|
|
304
|
+
|
|
267
305
|
|
|
268
306
|
### Return type
|
|
269
307
|
|
|
@@ -275,41 +313,47 @@ const { status, data } = await apiInstance.getRosterTemplate(id);
|
|
|
275
313
|
|
|
276
314
|
### HTTP request headers
|
|
277
315
|
|
|
278
|
-
- **Content-Type**: Not defined
|
|
279
|
-
- **Accept**: application/json
|
|
316
|
+
- **Content-Type**: Not defined
|
|
317
|
+
- **Accept**: application/json
|
|
280
318
|
|
|
281
|
-
### HTTP response details
|
|
282
319
|
|
|
320
|
+
### HTTP response details
|
|
283
321
|
| Status code | Description | Response headers |
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
322
|
+
|-------------|-------------|------------------|
|
|
323
|
+
|**200** | OK | - |
|
|
324
|
+
|**400** | Bad Request | - |
|
|
325
|
+
|**404** | Not Found | - |
|
|
288
326
|
|
|
289
327
|
[[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)
|
|
290
328
|
|
|
291
329
|
# **getRosterTemplates**
|
|
292
|
-
|
|
293
330
|
> Array<RosterTemplate> getRosterTemplates()
|
|
294
331
|
|
|
332
|
+
|
|
295
333
|
### Example
|
|
296
334
|
|
|
297
335
|
```typescript
|
|
298
|
-
import {
|
|
336
|
+
import {
|
|
337
|
+
RosterApi,
|
|
338
|
+
Configuration
|
|
339
|
+
} from './api';
|
|
299
340
|
|
|
300
341
|
const configuration = new Configuration();
|
|
301
342
|
const apiInstance = new RosterApi(configuration);
|
|
302
343
|
|
|
303
344
|
let organId: number; // (optional) (default to undefined)
|
|
304
345
|
|
|
305
|
-
const { status, data } = await apiInstance.getRosterTemplates(
|
|
346
|
+
const { status, data } = await apiInstance.getRosterTemplates(
|
|
347
|
+
organId
|
|
348
|
+
);
|
|
306
349
|
```
|
|
307
350
|
|
|
308
351
|
### Parameters
|
|
309
352
|
|
|
310
|
-
|
|
|
311
|
-
|
|
312
|
-
| **organId** | [**number**] |
|
|
353
|
+
|Name | Type | Description | Notes|
|
|
354
|
+
|------------- | ------------- | ------------- | -------------|
|
|
355
|
+
| **organId** | [**number**] | | (optional) defaults to undefined|
|
|
356
|
+
|
|
313
357
|
|
|
314
358
|
### Return type
|
|
315
359
|
|
|
@@ -321,26 +365,29 @@ const { status, data } = await apiInstance.getRosterTemplates(organId);
|
|
|
321
365
|
|
|
322
366
|
### HTTP request headers
|
|
323
367
|
|
|
324
|
-
- **Content-Type**: Not defined
|
|
325
|
-
- **Accept**: application/json
|
|
368
|
+
- **Content-Type**: Not defined
|
|
369
|
+
- **Accept**: application/json
|
|
326
370
|
|
|
327
|
-
### HTTP response details
|
|
328
371
|
|
|
372
|
+
### HTTP response details
|
|
329
373
|
| Status code | Description | Response headers |
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
374
|
+
|-------------|-------------|------------------|
|
|
375
|
+
|**200** | OK | - |
|
|
376
|
+
|**400** | Bad Request | - |
|
|
333
377
|
|
|
334
378
|
[[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)
|
|
335
379
|
|
|
336
380
|
# **getRosters**
|
|
337
|
-
|
|
338
381
|
> Array<Roster> getRosters()
|
|
339
382
|
|
|
383
|
+
|
|
340
384
|
### Example
|
|
341
385
|
|
|
342
386
|
```typescript
|
|
343
|
-
import {
|
|
387
|
+
import {
|
|
388
|
+
RosterApi,
|
|
389
|
+
Configuration
|
|
390
|
+
} from './api';
|
|
344
391
|
|
|
345
392
|
const configuration = new Configuration();
|
|
346
393
|
const apiInstance = new RosterApi(configuration);
|
|
@@ -348,15 +395,19 @@ const apiInstance = new RosterApi(configuration);
|
|
|
348
395
|
let date: string; //Date filter (ISO format) (optional) (default to undefined)
|
|
349
396
|
let organId: number; //Organ ID filter (optional) (default to undefined)
|
|
350
397
|
|
|
351
|
-
const { status, data } = await apiInstance.getRosters(
|
|
398
|
+
const { status, data } = await apiInstance.getRosters(
|
|
399
|
+
date,
|
|
400
|
+
organId
|
|
401
|
+
);
|
|
352
402
|
```
|
|
353
403
|
|
|
354
404
|
### Parameters
|
|
355
405
|
|
|
356
|
-
|
|
|
357
|
-
|
|
358
|
-
| **date**
|
|
359
|
-
| **organId** | [**number**] | Organ ID filter
|
|
406
|
+
|Name | Type | Description | Notes|
|
|
407
|
+
|------------- | ------------- | ------------- | -------------|
|
|
408
|
+
| **date** | [**string**] | Date filter (ISO format) | (optional) defaults to undefined|
|
|
409
|
+
| **organId** | [**number**] | Organ ID filter | (optional) defaults to undefined|
|
|
410
|
+
|
|
360
411
|
|
|
361
412
|
### Return type
|
|
362
413
|
|
|
@@ -368,26 +419,30 @@ const { status, data } = await apiInstance.getRosters(date, organId);
|
|
|
368
419
|
|
|
369
420
|
### HTTP request headers
|
|
370
421
|
|
|
371
|
-
- **Content-Type**: Not defined
|
|
372
|
-
- **Accept**: application/json
|
|
422
|
+
- **Content-Type**: Not defined
|
|
423
|
+
- **Accept**: application/json
|
|
373
424
|
|
|
374
|
-
### HTTP response details
|
|
375
425
|
|
|
426
|
+
### HTTP response details
|
|
376
427
|
| Status code | Description | Response headers |
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
428
|
+
|-------------|-------------|------------------|
|
|
429
|
+
|**200** | OK | - |
|
|
430
|
+
|**400** | Bad Request | - |
|
|
380
431
|
|
|
381
432
|
[[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)
|
|
382
433
|
|
|
383
434
|
# **updateRoster**
|
|
384
|
-
|
|
385
435
|
> Roster updateRoster(updateParams)
|
|
386
436
|
|
|
437
|
+
|
|
387
438
|
### Example
|
|
388
439
|
|
|
389
440
|
```typescript
|
|
390
|
-
import {
|
|
441
|
+
import {
|
|
442
|
+
RosterApi,
|
|
443
|
+
Configuration,
|
|
444
|
+
RosterUpdateRequest
|
|
445
|
+
} from './api';
|
|
391
446
|
|
|
392
447
|
const configuration = new Configuration();
|
|
393
448
|
const apiInstance = new RosterApi(configuration);
|
|
@@ -395,15 +450,19 @@ const apiInstance = new RosterApi(configuration);
|
|
|
395
450
|
let id: number; //Roster ID (default to undefined)
|
|
396
451
|
let updateParams: RosterUpdateRequest; //Roster input
|
|
397
452
|
|
|
398
|
-
const { status, data } = await apiInstance.updateRoster(
|
|
453
|
+
const { status, data } = await apiInstance.updateRoster(
|
|
454
|
+
id,
|
|
455
|
+
updateParams
|
|
456
|
+
);
|
|
399
457
|
```
|
|
400
458
|
|
|
401
459
|
### Parameters
|
|
402
460
|
|
|
403
|
-
|
|
|
404
|
-
|
|
405
|
-
| **updateParams** | **RosterUpdateRequest
|
|
406
|
-
| **id**
|
|
461
|
+
|Name | Type | Description | Notes|
|
|
462
|
+
|------------- | ------------- | ------------- | -------------|
|
|
463
|
+
| **updateParams** | **RosterUpdateRequest**| Roster input | |
|
|
464
|
+
| **id** | [**number**] | Roster ID | defaults to undefined|
|
|
465
|
+
|
|
407
466
|
|
|
408
467
|
### Return type
|
|
409
468
|
|
|
@@ -415,14 +474,15 @@ const { status, data } = await apiInstance.updateRoster(id, updateParams);
|
|
|
415
474
|
|
|
416
475
|
### HTTP request headers
|
|
417
476
|
|
|
418
|
-
- **Content-Type**: application/json
|
|
419
|
-
- **Accept**: application/json
|
|
477
|
+
- **Content-Type**: application/json
|
|
478
|
+
- **Accept**: application/json
|
|
420
479
|
|
|
421
|
-
### HTTP response details
|
|
422
480
|
|
|
481
|
+
### HTTP response details
|
|
423
482
|
| Status code | Description | Response headers |
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
483
|
+
|-------------|-------------|------------------|
|
|
484
|
+
|**200** | OK | - |
|
|
485
|
+
|**400** | Bad Request | - |
|
|
427
486
|
|
|
428
487
|
[[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)
|
|
488
|
+
|
|
@@ -1,24 +1,25 @@
|
|
|
1
1
|
# RosterCreateRequest
|
|
2
2
|
|
|
3
|
+
|
|
3
4
|
## Properties
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**date** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**organId** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**shifts** | **Array<string>** | | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
14
15
|
```typescript
|
|
15
|
-
import { RosterCreateRequest } from
|
|
16
|
+
import { RosterCreateRequest } from './api';
|
|
16
17
|
|
|
17
18
|
const instance: RosterCreateRequest = {
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
19
|
+
date,
|
|
20
|
+
name,
|
|
21
|
+
organId,
|
|
22
|
+
shifts,
|
|
22
23
|
};
|
|
23
24
|
```
|
|
24
25
|
|
package/src/docs/RosterShift.md
CHANGED
|
@@ -1,28 +1,29 @@
|
|
|
1
1
|
# RosterShift
|
|
2
2
|
|
|
3
|
+
|
|
3
4
|
## Properties
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
| ------------- |
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**createdAt** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) | | [optional] [default to undefined]
|
|
10
|
+
**id** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**rosterId** | **number** | | [optional] [default to undefined]
|
|
13
|
+
**updatedAt** | **string** | | [optional] [default to undefined]
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
16
17
|
```typescript
|
|
17
|
-
import { RosterShift } from
|
|
18
|
+
import { RosterShift } from './api';
|
|
18
19
|
|
|
19
20
|
const instance: RosterShift = {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
21
|
+
createdAt,
|
|
22
|
+
deletedAt,
|
|
23
|
+
id,
|
|
24
|
+
name,
|
|
25
|
+
rosterId,
|
|
26
|
+
updatedAt,
|
|
26
27
|
};
|
|
27
28
|
```
|
|
28
29
|
|