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