@gewis/grooster-backend-ts 1.5.1 → 1.5.2

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 CHANGED
@@ -9,10 +9,10 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { Configuration } from "./configuration";
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from "axios";
14
- import type { RequestArgs } from "./base";
15
- import { BaseAPI } from "./base";
12
+ import type { Configuration } from './configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import type { RequestArgs } from './base';
15
+ import { BaseAPI } from './base';
16
16
  /**
17
17
  *
18
18
  * @export
@@ -24,13 +24,51 @@ export interface GormDeletedAt {
24
24
  * @type {string}
25
25
  * @memberof GormDeletedAt
26
26
  */
27
- time?: string;
27
+ 'time'?: string;
28
28
  /**
29
29
  * Valid is true if Time is not NULL
30
30
  * @type {boolean}
31
31
  * @memberof GormDeletedAt
32
32
  */
33
- valid?: boolean;
33
+ 'valid'?: boolean;
34
+ }
35
+ /**
36
+ *
37
+ * @export
38
+ * @interface ModelsSavedShiftOrdering
39
+ */
40
+ export interface ModelsSavedShiftOrdering {
41
+ /**
42
+ *
43
+ * @type {string}
44
+ * @memberof ModelsSavedShiftOrdering
45
+ */
46
+ 'shiftName'?: string;
47
+ /**
48
+ *
49
+ * @type {Array<User>}
50
+ * @memberof ModelsSavedShiftOrdering
51
+ */
52
+ 'users'?: Array<User>;
53
+ }
54
+ /**
55
+ *
56
+ * @export
57
+ * @interface ModelsSavedShiftResponse
58
+ */
59
+ export interface ModelsSavedShiftResponse {
60
+ /**
61
+ *
62
+ * @type {Array<ModelsSavedShiftOrdering>}
63
+ * @memberof ModelsSavedShiftResponse
64
+ */
65
+ 'savedShiftOrdering'?: Array<ModelsSavedShiftOrdering>;
66
+ /**
67
+ *
68
+ * @type {Array<SavedShift>}
69
+ * @memberof ModelsSavedShiftResponse
70
+ */
71
+ 'savedShifts'?: Array<SavedShift>;
34
72
  }
35
73
  /**
36
74
  * An organ that users can be part of.
@@ -43,37 +81,37 @@ export interface Organ {
43
81
  * @type {string}
44
82
  * @memberof Organ
45
83
  */
46
- createdAt?: string;
84
+ 'createdAt'?: string;
47
85
  /**
48
86
  *
49
87
  * @type {GormDeletedAt}
50
88
  * @memberof Organ
51
89
  */
52
- deletedAt?: GormDeletedAt;
90
+ 'deletedAt'?: GormDeletedAt;
53
91
  /**
54
92
  *
55
93
  * @type {number}
56
94
  * @memberof Organ
57
95
  */
58
- id?: number;
96
+ 'id'?: number;
59
97
  /**
60
98
  *
61
99
  * @type {string}
62
100
  * @memberof Organ
63
101
  */
64
- name?: string;
102
+ 'name'?: string;
65
103
  /**
66
104
  *
67
105
  * @type {string}
68
106
  * @memberof Organ
69
107
  */
70
- updatedAt?: string;
108
+ 'updatedAt'?: string;
71
109
  /**
72
110
  *
73
111
  * @type {Array<User>}
74
112
  * @memberof Organ
75
113
  */
76
- users?: Array<User>;
114
+ 'users'?: Array<User>;
77
115
  }
78
116
  /**
79
117
  *
@@ -86,73 +124,73 @@ export interface Roster {
86
124
  * @type {string}
87
125
  * @memberof Roster
88
126
  */
89
- createdAt?: string;
127
+ 'createdAt'?: string;
90
128
  /**
91
129
  *
92
130
  * @type {string}
93
131
  * @memberof Roster
94
132
  */
95
- date?: string;
133
+ 'date'?: string;
96
134
  /**
97
135
  *
98
136
  * @type {GormDeletedAt}
99
137
  * @memberof Roster
100
138
  */
101
- deletedAt?: GormDeletedAt;
139
+ 'deletedAt'?: GormDeletedAt;
102
140
  /**
103
141
  *
104
142
  * @type {number}
105
143
  * @memberof Roster
106
144
  */
107
- id?: number;
145
+ 'id'?: number;
108
146
  /**
109
147
  *
110
148
  * @type {string}
111
149
  * @memberof Roster
112
150
  */
113
- name?: string;
151
+ 'name'?: string;
114
152
  /**
115
153
  *
116
154
  * @type {Organ}
117
155
  * @memberof Roster
118
156
  */
119
- organ?: Organ;
157
+ 'organ'?: Organ;
120
158
  /**
121
159
  *
122
160
  * @type {number}
123
161
  * @memberof Roster
124
162
  */
125
- organId?: number;
163
+ 'organId'?: number;
126
164
  /**
127
165
  *
128
166
  * @type {Array<RosterAnswer>}
129
167
  * @memberof Roster
130
168
  */
131
- rosterAnswer?: Array<RosterAnswer>;
169
+ 'rosterAnswer'?: Array<RosterAnswer>;
132
170
  /**
133
171
  *
134
172
  * @type {Array<RosterShift>}
135
173
  * @memberof Roster
136
174
  */
137
- rosterShift?: Array<RosterShift>;
175
+ 'rosterShift'?: Array<RosterShift>;
138
176
  /**
139
177
  *
140
178
  * @type {boolean}
141
179
  * @memberof Roster
142
180
  */
143
- saved?: boolean;
181
+ 'saved'?: boolean;
144
182
  /**
145
183
  *
146
184
  * @type {string}
147
185
  * @memberof Roster
148
186
  */
149
- updatedAt?: string;
187
+ 'updatedAt'?: string;
150
188
  /**
151
189
  *
152
190
  * @type {Array<string>}
153
191
  * @memberof Roster
154
192
  */
155
- values?: Array<string>;
193
+ 'values'?: Array<string>;
156
194
  }
157
195
  /**
158
196
  *
@@ -165,49 +203,49 @@ export interface RosterAnswer {
165
203
  * @type {string}
166
204
  * @memberof RosterAnswer
167
205
  */
168
- createdAt?: string;
206
+ 'createdAt'?: string;
169
207
  /**
170
208
  *
171
209
  * @type {GormDeletedAt}
172
210
  * @memberof RosterAnswer
173
211
  */
174
- deletedAt?: GormDeletedAt;
212
+ 'deletedAt'?: GormDeletedAt;
175
213
  /**
176
214
  *
177
215
  * @type {number}
178
216
  * @memberof RosterAnswer
179
217
  */
180
- id?: number;
218
+ 'id'?: number;
181
219
  /**
182
220
  *
183
221
  * @type {number}
184
222
  * @memberof RosterAnswer
185
223
  */
186
- rosterId?: number;
224
+ 'rosterId'?: number;
187
225
  /**
188
226
  *
189
227
  * @type {number}
190
228
  * @memberof RosterAnswer
191
229
  */
192
- rosterShiftId?: number;
230
+ 'rosterShiftId'?: number;
193
231
  /**
194
232
  *
195
233
  * @type {string}
196
234
  * @memberof RosterAnswer
197
235
  */
198
- updatedAt?: string;
236
+ 'updatedAt'?: string;
199
237
  /**
200
238
  *
201
239
  * @type {number}
202
240
  * @memberof RosterAnswer
203
241
  */
204
- userId?: number;
242
+ 'userId'?: number;
205
243
  /**
206
244
  *
207
245
  * @type {string}
208
246
  * @memberof RosterAnswer
209
247
  */
210
- value?: string;
248
+ 'value'?: string;
211
249
  }
212
250
  /**
213
251
  *
@@ -220,25 +258,25 @@ export interface RosterAnswerCreateRequest {
220
258
  * @type {number}
221
259
  * @memberof RosterAnswerCreateRequest
222
260
  */
223
- rosterId?: number;
261
+ 'rosterId'?: number;
224
262
  /**
225
263
  *
226
264
  * @type {number}
227
265
  * @memberof RosterAnswerCreateRequest
228
266
  */
229
- rosterShiftId?: number;
267
+ 'rosterShiftId'?: number;
230
268
  /**
231
269
  *
232
270
  * @type {number}
233
271
  * @memberof RosterAnswerCreateRequest
234
272
  */
235
- userId?: number;
273
+ 'userId'?: number;
236
274
  /**
237
275
  *
238
276
  * @type {string}
239
277
  * @memberof RosterAnswerCreateRequest
240
278
  */
241
- value?: string;
279
+ 'value'?: string;
242
280
  }
243
281
  /**
244
282
  *
@@ -251,7 +289,7 @@ export interface RosterAnswerUpdateRequest {
251
289
  * @type {string}
252
290
  * @memberof RosterAnswerUpdateRequest
253
291
  */
254
- value?: string;
292
+ 'value'?: string;
255
293
  }
256
294
  /**
257
295
  *
@@ -264,25 +302,25 @@ export interface RosterCreateRequest {
264
302
  * @type {string}
265
303
  * @memberof RosterCreateRequest
266
304
  */
267
- date?: string;
305
+ 'date'?: string;
268
306
  /**
269
307
  *
270
308
  * @type {string}
271
309
  * @memberof RosterCreateRequest
272
310
  */
273
- name?: string;
311
+ 'name'?: string;
274
312
  /**
275
313
  *
276
314
  * @type {number}
277
315
  * @memberof RosterCreateRequest
278
316
  */
279
- organId?: number;
317
+ 'organId'?: number;
280
318
  /**
281
319
  *
282
320
  * @type {Array<string>}
283
321
  * @memberof RosterCreateRequest
284
322
  */
285
- shifts?: Array<string>;
323
+ 'shifts'?: Array<string>;
286
324
  }
287
325
  /**
288
326
  *
@@ -295,37 +333,37 @@ export interface RosterShift {
295
333
  * @type {string}
296
334
  * @memberof RosterShift
297
335
  */
298
- createdAt?: string;
336
+ 'createdAt'?: string;
299
337
  /**
300
338
  *
301
339
  * @type {GormDeletedAt}
302
340
  * @memberof RosterShift
303
341
  */
304
- deletedAt?: GormDeletedAt;
342
+ 'deletedAt'?: GormDeletedAt;
305
343
  /**
306
344
  *
307
345
  * @type {number}
308
346
  * @memberof RosterShift
309
347
  */
310
- id?: number;
348
+ 'id'?: number;
311
349
  /**
312
350
  *
313
351
  * @type {string}
314
352
  * @memberof RosterShift
315
353
  */
316
- name?: string;
354
+ 'name'?: string;
317
355
  /**
318
356
  *
319
357
  * @type {number}
320
358
  * @memberof RosterShift
321
359
  */
322
- rosterId?: number;
360
+ 'rosterId'?: number;
323
361
  /**
324
362
  *
325
363
  * @type {string}
326
364
  * @memberof RosterShift
327
365
  */
328
- updatedAt?: string;
366
+ 'updatedAt'?: string;
329
367
  }
330
368
  /**
331
369
  *
@@ -338,13 +376,13 @@ export interface RosterShiftCreateRequest {
338
376
  * @type {string}
339
377
  * @memberof RosterShiftCreateRequest
340
378
  */
341
- name?: string;
379
+ 'name'?: string;
342
380
  /**
343
381
  *
344
382
  * @type {number}
345
383
  * @memberof RosterShiftCreateRequest
346
384
  */
347
- rosterId?: number;
385
+ 'rosterId'?: number;
348
386
  }
349
387
  /**
350
388
  *
@@ -357,43 +395,43 @@ export interface RosterTemplate {
357
395
  * @type {string}
358
396
  * @memberof RosterTemplate
359
397
  */
360
- createdAt?: string;
398
+ 'createdAt'?: string;
361
399
  /**
362
400
  *
363
401
  * @type {GormDeletedAt}
364
402
  * @memberof RosterTemplate
365
403
  */
366
- deletedAt?: GormDeletedAt;
404
+ 'deletedAt'?: GormDeletedAt;
367
405
  /**
368
406
  *
369
407
  * @type {number}
370
408
  * @memberof RosterTemplate
371
409
  */
372
- id?: number;
410
+ 'id'?: number;
373
411
  /**
374
412
  *
375
413
  * @type {string}
376
414
  * @memberof RosterTemplate
377
415
  */
378
- name?: string;
416
+ 'name'?: string;
379
417
  /**
380
418
  *
381
419
  * @type {number}
382
420
  * @memberof RosterTemplate
383
421
  */
384
- organId?: number;
422
+ 'organId'?: number;
385
423
  /**
386
424
  *
387
425
  * @type {Array<string>}
388
426
  * @memberof RosterTemplate
389
427
  */
390
- shifts?: Array<string>;
428
+ 'shifts'?: Array<string>;
391
429
  /**
392
430
  *
393
431
  * @type {string}
394
432
  * @memberof RosterTemplate
395
433
  */
396
- updatedAt?: string;
434
+ 'updatedAt'?: string;
397
435
  }
398
436
  /**
399
437
  *
@@ -406,19 +444,19 @@ export interface RosterTemplateCreateRequest {
406
444
  * @type {string}
407
445
  * @memberof RosterTemplateCreateRequest
408
446
  */
409
- name?: string;
447
+ 'name'?: string;
410
448
  /**
411
449
  *
412
450
  * @type {number}
413
451
  * @memberof RosterTemplateCreateRequest
414
452
  */
415
- organId?: number;
453
+ 'organId'?: number;
416
454
  /**
417
455
  *
418
456
  * @type {Array<string>}
419
457
  * @memberof RosterTemplateCreateRequest
420
458
  */
421
- shifts?: Array<string>;
459
+ 'shifts'?: Array<string>;
422
460
  }
423
461
  /**
424
462
  *
@@ -431,13 +469,13 @@ export interface RosterTemplateUpdateParams {
431
469
  * @type {string}
432
470
  * @memberof RosterTemplateUpdateParams
433
471
  */
434
- name?: string;
472
+ 'name'?: string;
435
473
  /**
436
474
  *
437
475
  * @type {Array<string>}
438
476
  * @memberof RosterTemplateUpdateParams
439
477
  */
440
- shifts?: Array<string>;
478
+ 'shifts'?: Array<string>;
441
479
  }
442
480
  /**
443
481
  *
@@ -450,13 +488,13 @@ export interface RosterUpdateRequest {
450
488
  * @type {string}
451
489
  * @memberof RosterUpdateRequest
452
490
  */
453
- date?: string;
491
+ 'date'?: string;
454
492
  /**
455
493
  *
456
494
  * @type {string}
457
495
  * @memberof RosterUpdateRequest
458
496
  */
459
- name?: string;
497
+ 'name'?: string;
460
498
  }
461
499
  /**
462
500
  *
@@ -469,49 +507,49 @@ export interface SavedShift {
469
507
  * @type {string}
470
508
  * @memberof SavedShift
471
509
  */
472
- createdAt?: string;
510
+ 'createdAt'?: string;
473
511
  /**
474
512
  *
475
513
  * @type {GormDeletedAt}
476
514
  * @memberof SavedShift
477
515
  */
478
- deletedAt?: GormDeletedAt;
516
+ 'deletedAt'?: GormDeletedAt;
479
517
  /**
480
518
  *
481
519
  * @type {number}
482
520
  * @memberof SavedShift
483
521
  */
484
- id?: number;
522
+ 'id'?: number;
485
523
  /**
486
524
  *
487
525
  * @type {number}
488
526
  * @memberof SavedShift
489
527
  */
490
- rosterId?: number;
528
+ 'rosterId'?: number;
491
529
  /**
492
530
  *
493
531
  * @type {RosterShift}
494
532
  * @memberof SavedShift
495
533
  */
496
- rosterShift?: RosterShift;
534
+ 'rosterShift'?: RosterShift;
497
535
  /**
498
536
  *
499
537
  * @type {number}
500
538
  * @memberof SavedShift
501
539
  */
502
- rosterShiftId?: number;
540
+ 'rosterShiftId'?: number;
503
541
  /**
504
542
  *
505
543
  * @type {string}
506
544
  * @memberof SavedShift
507
545
  */
508
- updatedAt?: string;
546
+ 'updatedAt'?: string;
509
547
  /**
510
548
  *
511
549
  * @type {Array<User>}
512
550
  * @memberof SavedShift
513
551
  */
514
- users?: Array<User>;
552
+ 'users'?: Array<User>;
515
553
  }
516
554
  /**
517
555
  *
@@ -524,7 +562,7 @@ export interface SavedShiftUpdateRequest {
524
562
  * @type {Array<number>}
525
563
  * @memberof SavedShiftUpdateRequest
526
564
  */
527
- users?: Array<number>;
565
+ 'users'?: Array<number>;
528
566
  }
529
567
  /**
530
568
  *
@@ -537,43 +575,43 @@ export interface User {
537
575
  * @type {string}
538
576
  * @memberof User
539
577
  */
540
- createdAt?: string;
578
+ 'createdAt'?: string;
541
579
  /**
542
580
  *
543
581
  * @type {GormDeletedAt}
544
582
  * @memberof User
545
583
  */
546
- deletedAt?: GormDeletedAt;
584
+ 'deletedAt'?: GormDeletedAt;
547
585
  /**
548
586
  *
549
587
  * @type {number}
550
588
  * @memberof User
551
589
  */
552
- gewis_id?: number;
590
+ 'gewis_id'?: number;
553
591
  /**
554
592
  *
555
593
  * @type {number}
556
594
  * @memberof User
557
595
  */
558
- id?: number;
596
+ 'id'?: number;
559
597
  /**
560
598
  *
561
599
  * @type {string}
562
600
  * @memberof User
563
601
  */
564
- name?: string;
602
+ 'name'?: string;
565
603
  /**
566
604
  *
567
605
  * @type {Array<Organ>}
568
606
  * @memberof User
569
607
  */
570
- organs?: Array<Organ>;
608
+ 'organs'?: Array<Organ>;
571
609
  /**
572
610
  *
573
611
  * @type {string}
574
612
  * @memberof User
575
613
  */
576
- updatedAt?: string;
614
+ 'updatedAt'?: string;
577
615
  }
578
616
  /**
579
617
  *
@@ -586,19 +624,19 @@ export interface UserCreateRequest {
586
624
  * @type {number}
587
625
  * @memberof UserCreateRequest
588
626
  */
589
- gewisid?: number;
627
+ 'gewisid'?: number;
590
628
  /**
591
629
  *
592
630
  * @type {string}
593
631
  * @memberof UserCreateRequest
594
632
  */
595
- name?: string;
633
+ 'name'?: string;
596
634
  /**
597
635
  *
598
636
  * @type {Array<Organ>}
599
637
  * @memberof UserCreateRequest
600
638
  */
601
- organs?: Array<Organ>;
639
+ 'organs'?: Array<Organ>;
602
640
  }
603
641
  /**
604
642
  * AuthApi - axios parameter creator
@@ -1301,7 +1339,7 @@ export declare const SavedShiftApiFp: (configuration?: Configuration) => {
1301
1339
  * @param {*} [options] Override http request option.
1302
1340
  * @throws {RequiredError}
1303
1341
  */
1304
- getSavedRoster(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SavedShift>>>;
1342
+ getSavedRoster(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ModelsSavedShiftResponse>>;
1305
1343
  /**
1306
1344
  *
1307
1345
  * @summary Save a specific roster
@@ -1332,7 +1370,7 @@ export declare const SavedShiftApiFactory: (configuration?: Configuration, baseP
1332
1370
  * @param {*} [options] Override http request option.
1333
1371
  * @throws {RequiredError}
1334
1372
  */
1335
- getSavedRoster(id: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<SavedShift>>;
1373
+ getSavedRoster(id: number, options?: RawAxiosRequestConfig): AxiosPromise<ModelsSavedShiftResponse>;
1336
1374
  /**
1337
1375
  *
1338
1376
  * @summary Save a specific roster
@@ -1366,7 +1404,7 @@ export declare class SavedShiftApi extends BaseAPI {
1366
1404
  * @throws {RequiredError}
1367
1405
  * @memberof SavedShiftApi
1368
1406
  */
1369
- getSavedRoster(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedShift[], any, {}>>;
1407
+ getSavedRoster(id: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ModelsSavedShiftResponse, any, {}>>;
1370
1408
  /**
1371
1409
  *
1372
1410
  * @summary Save a specific roster