@gewis/grooster-backend-ts 1.5.1 → 1.5.3

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,13 @@ 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
34
  }
35
35
  /**
36
36
  * An organ that users can be part of.
@@ -43,37 +43,37 @@ export interface Organ {
43
43
  * @type {string}
44
44
  * @memberof Organ
45
45
  */
46
- createdAt?: string;
46
+ 'createdAt'?: string;
47
47
  /**
48
48
  *
49
49
  * @type {GormDeletedAt}
50
50
  * @memberof Organ
51
51
  */
52
- deletedAt?: GormDeletedAt;
52
+ 'deletedAt'?: GormDeletedAt;
53
53
  /**
54
54
  *
55
55
  * @type {number}
56
56
  * @memberof Organ
57
57
  */
58
- id?: number;
58
+ 'id'?: number;
59
59
  /**
60
60
  *
61
61
  * @type {string}
62
62
  * @memberof Organ
63
63
  */
64
- name?: string;
64
+ 'name'?: string;
65
65
  /**
66
66
  *
67
67
  * @type {string}
68
68
  * @memberof Organ
69
69
  */
70
- updatedAt?: string;
70
+ 'updatedAt'?: string;
71
71
  /**
72
72
  *
73
73
  * @type {Array<User>}
74
74
  * @memberof Organ
75
75
  */
76
- users?: Array<User>;
76
+ 'users'?: Array<User>;
77
77
  }
78
78
  /**
79
79
  *
@@ -86,73 +86,73 @@ export interface Roster {
86
86
  * @type {string}
87
87
  * @memberof Roster
88
88
  */
89
- createdAt?: string;
89
+ 'createdAt'?: string;
90
90
  /**
91
91
  *
92
92
  * @type {string}
93
93
  * @memberof Roster
94
94
  */
95
- date?: string;
95
+ 'date'?: string;
96
96
  /**
97
97
  *
98
98
  * @type {GormDeletedAt}
99
99
  * @memberof Roster
100
100
  */
101
- deletedAt?: GormDeletedAt;
101
+ 'deletedAt'?: GormDeletedAt;
102
102
  /**
103
103
  *
104
104
  * @type {number}
105
105
  * @memberof Roster
106
106
  */
107
- id?: number;
107
+ 'id'?: number;
108
108
  /**
109
109
  *
110
110
  * @type {string}
111
111
  * @memberof Roster
112
112
  */
113
- name?: string;
113
+ 'name'?: string;
114
114
  /**
115
115
  *
116
116
  * @type {Organ}
117
117
  * @memberof Roster
118
118
  */
119
- organ?: Organ;
119
+ 'organ'?: Organ;
120
120
  /**
121
121
  *
122
122
  * @type {number}
123
123
  * @memberof Roster
124
124
  */
125
- organId?: number;
125
+ 'organId'?: number;
126
126
  /**
127
127
  *
128
128
  * @type {Array<RosterAnswer>}
129
129
  * @memberof Roster
130
130
  */
131
- rosterAnswer?: Array<RosterAnswer>;
131
+ 'rosterAnswer'?: Array<RosterAnswer>;
132
132
  /**
133
133
  *
134
134
  * @type {Array<RosterShift>}
135
135
  * @memberof Roster
136
136
  */
137
- rosterShift?: Array<RosterShift>;
137
+ 'rosterShift'?: Array<RosterShift>;
138
138
  /**
139
139
  *
140
140
  * @type {boolean}
141
141
  * @memberof Roster
142
142
  */
143
- saved?: boolean;
143
+ 'saved'?: boolean;
144
144
  /**
145
145
  *
146
146
  * @type {string}
147
147
  * @memberof Roster
148
148
  */
149
- updatedAt?: string;
149
+ 'updatedAt'?: string;
150
150
  /**
151
151
  *
152
152
  * @type {Array<string>}
153
153
  * @memberof Roster
154
154
  */
155
- values?: Array<string>;
155
+ 'values'?: Array<string>;
156
156
  }
157
157
  /**
158
158
  *
@@ -165,49 +165,49 @@ export interface RosterAnswer {
165
165
  * @type {string}
166
166
  * @memberof RosterAnswer
167
167
  */
168
- createdAt?: string;
168
+ 'createdAt'?: string;
169
169
  /**
170
170
  *
171
171
  * @type {GormDeletedAt}
172
172
  * @memberof RosterAnswer
173
173
  */
174
- deletedAt?: GormDeletedAt;
174
+ 'deletedAt'?: GormDeletedAt;
175
175
  /**
176
176
  *
177
177
  * @type {number}
178
178
  * @memberof RosterAnswer
179
179
  */
180
- id?: number;
180
+ 'id'?: number;
181
181
  /**
182
182
  *
183
183
  * @type {number}
184
184
  * @memberof RosterAnswer
185
185
  */
186
- rosterId?: number;
186
+ 'rosterId'?: number;
187
187
  /**
188
188
  *
189
189
  * @type {number}
190
190
  * @memberof RosterAnswer
191
191
  */
192
- rosterShiftId?: number;
192
+ 'rosterShiftId'?: number;
193
193
  /**
194
194
  *
195
195
  * @type {string}
196
196
  * @memberof RosterAnswer
197
197
  */
198
- updatedAt?: string;
198
+ 'updatedAt'?: string;
199
199
  /**
200
200
  *
201
201
  * @type {number}
202
202
  * @memberof RosterAnswer
203
203
  */
204
- userId?: number;
204
+ 'userId'?: number;
205
205
  /**
206
206
  *
207
207
  * @type {string}
208
208
  * @memberof RosterAnswer
209
209
  */
210
- value?: string;
210
+ 'value'?: string;
211
211
  }
212
212
  /**
213
213
  *
@@ -220,25 +220,25 @@ export interface RosterAnswerCreateRequest {
220
220
  * @type {number}
221
221
  * @memberof RosterAnswerCreateRequest
222
222
  */
223
- rosterId?: number;
223
+ 'rosterId'?: number;
224
224
  /**
225
225
  *
226
226
  * @type {number}
227
227
  * @memberof RosterAnswerCreateRequest
228
228
  */
229
- rosterShiftId?: number;
229
+ 'rosterShiftId'?: number;
230
230
  /**
231
231
  *
232
232
  * @type {number}
233
233
  * @memberof RosterAnswerCreateRequest
234
234
  */
235
- userId?: number;
235
+ 'userId'?: number;
236
236
  /**
237
237
  *
238
238
  * @type {string}
239
239
  * @memberof RosterAnswerCreateRequest
240
240
  */
241
- value?: string;
241
+ 'value'?: string;
242
242
  }
243
243
  /**
244
244
  *
@@ -251,7 +251,7 @@ export interface RosterAnswerUpdateRequest {
251
251
  * @type {string}
252
252
  * @memberof RosterAnswerUpdateRequest
253
253
  */
254
- value?: string;
254
+ 'value'?: string;
255
255
  }
256
256
  /**
257
257
  *
@@ -264,25 +264,25 @@ export interface RosterCreateRequest {
264
264
  * @type {string}
265
265
  * @memberof RosterCreateRequest
266
266
  */
267
- date?: string;
267
+ 'date'?: string;
268
268
  /**
269
269
  *
270
270
  * @type {string}
271
271
  * @memberof RosterCreateRequest
272
272
  */
273
- name?: string;
273
+ 'name'?: string;
274
274
  /**
275
275
  *
276
276
  * @type {number}
277
277
  * @memberof RosterCreateRequest
278
278
  */
279
- organId?: number;
279
+ 'organId'?: number;
280
280
  /**
281
281
  *
282
282
  * @type {Array<string>}
283
283
  * @memberof RosterCreateRequest
284
284
  */
285
- shifts?: Array<string>;
285
+ 'shifts'?: Array<string>;
286
286
  }
287
287
  /**
288
288
  *
@@ -295,37 +295,37 @@ export interface RosterShift {
295
295
  * @type {string}
296
296
  * @memberof RosterShift
297
297
  */
298
- createdAt?: string;
298
+ 'createdAt'?: string;
299
299
  /**
300
300
  *
301
301
  * @type {GormDeletedAt}
302
302
  * @memberof RosterShift
303
303
  */
304
- deletedAt?: GormDeletedAt;
304
+ 'deletedAt'?: GormDeletedAt;
305
305
  /**
306
306
  *
307
307
  * @type {number}
308
308
  * @memberof RosterShift
309
309
  */
310
- id?: number;
310
+ 'id'?: number;
311
311
  /**
312
312
  *
313
313
  * @type {string}
314
314
  * @memberof RosterShift
315
315
  */
316
- name?: string;
316
+ 'name'?: string;
317
317
  /**
318
318
  *
319
319
  * @type {number}
320
320
  * @memberof RosterShift
321
321
  */
322
- rosterId?: number;
322
+ 'rosterId'?: number;
323
323
  /**
324
324
  *
325
325
  * @type {string}
326
326
  * @memberof RosterShift
327
327
  */
328
- updatedAt?: string;
328
+ 'updatedAt'?: string;
329
329
  }
330
330
  /**
331
331
  *
@@ -338,13 +338,13 @@ export interface RosterShiftCreateRequest {
338
338
  * @type {string}
339
339
  * @memberof RosterShiftCreateRequest
340
340
  */
341
- name?: string;
341
+ 'name'?: string;
342
342
  /**
343
343
  *
344
344
  * @type {number}
345
345
  * @memberof RosterShiftCreateRequest
346
346
  */
347
- rosterId?: number;
347
+ 'rosterId'?: number;
348
348
  }
349
349
  /**
350
350
  *
@@ -357,43 +357,43 @@ export interface RosterTemplate {
357
357
  * @type {string}
358
358
  * @memberof RosterTemplate
359
359
  */
360
- createdAt?: string;
360
+ 'createdAt'?: string;
361
361
  /**
362
362
  *
363
363
  * @type {GormDeletedAt}
364
364
  * @memberof RosterTemplate
365
365
  */
366
- deletedAt?: GormDeletedAt;
366
+ 'deletedAt'?: GormDeletedAt;
367
367
  /**
368
368
  *
369
369
  * @type {number}
370
370
  * @memberof RosterTemplate
371
371
  */
372
- id?: number;
372
+ 'id'?: number;
373
373
  /**
374
374
  *
375
375
  * @type {string}
376
376
  * @memberof RosterTemplate
377
377
  */
378
- name?: string;
378
+ 'name'?: string;
379
379
  /**
380
380
  *
381
381
  * @type {number}
382
382
  * @memberof RosterTemplate
383
383
  */
384
- organId?: number;
384
+ 'organId'?: number;
385
385
  /**
386
386
  *
387
387
  * @type {Array<string>}
388
388
  * @memberof RosterTemplate
389
389
  */
390
- shifts?: Array<string>;
390
+ 'shifts'?: Array<string>;
391
391
  /**
392
392
  *
393
393
  * @type {string}
394
394
  * @memberof RosterTemplate
395
395
  */
396
- updatedAt?: string;
396
+ 'updatedAt'?: string;
397
397
  }
398
398
  /**
399
399
  *
@@ -406,19 +406,19 @@ export interface RosterTemplateCreateRequest {
406
406
  * @type {string}
407
407
  * @memberof RosterTemplateCreateRequest
408
408
  */
409
- name?: string;
409
+ 'name'?: string;
410
410
  /**
411
411
  *
412
412
  * @type {number}
413
413
  * @memberof RosterTemplateCreateRequest
414
414
  */
415
- organId?: number;
415
+ 'organId'?: number;
416
416
  /**
417
417
  *
418
418
  * @type {Array<string>}
419
419
  * @memberof RosterTemplateCreateRequest
420
420
  */
421
- shifts?: Array<string>;
421
+ 'shifts'?: Array<string>;
422
422
  }
423
423
  /**
424
424
  *
@@ -431,13 +431,13 @@ export interface RosterTemplateUpdateParams {
431
431
  * @type {string}
432
432
  * @memberof RosterTemplateUpdateParams
433
433
  */
434
- name?: string;
434
+ 'name'?: string;
435
435
  /**
436
436
  *
437
437
  * @type {Array<string>}
438
438
  * @memberof RosterTemplateUpdateParams
439
439
  */
440
- shifts?: Array<string>;
440
+ 'shifts'?: Array<string>;
441
441
  }
442
442
  /**
443
443
  *
@@ -450,13 +450,13 @@ export interface RosterUpdateRequest {
450
450
  * @type {string}
451
451
  * @memberof RosterUpdateRequest
452
452
  */
453
- date?: string;
453
+ 'date'?: string;
454
454
  /**
455
455
  *
456
456
  * @type {string}
457
457
  * @memberof RosterUpdateRequest
458
458
  */
459
- name?: string;
459
+ 'name'?: string;
460
460
  }
461
461
  /**
462
462
  *
@@ -469,49 +469,87 @@ export interface SavedShift {
469
469
  * @type {string}
470
470
  * @memberof SavedShift
471
471
  */
472
- createdAt?: string;
472
+ 'createdAt'?: string;
473
473
  /**
474
474
  *
475
475
  * @type {GormDeletedAt}
476
476
  * @memberof SavedShift
477
477
  */
478
- deletedAt?: GormDeletedAt;
478
+ 'deletedAt'?: GormDeletedAt;
479
479
  /**
480
480
  *
481
481
  * @type {number}
482
482
  * @memberof SavedShift
483
483
  */
484
- id?: number;
484
+ 'id'?: number;
485
485
  /**
486
486
  *
487
487
  * @type {number}
488
488
  * @memberof SavedShift
489
489
  */
490
- rosterId?: number;
490
+ 'rosterId'?: number;
491
491
  /**
492
492
  *
493
493
  * @type {RosterShift}
494
494
  * @memberof SavedShift
495
495
  */
496
- rosterShift?: RosterShift;
496
+ 'rosterShift'?: RosterShift;
497
497
  /**
498
498
  *
499
499
  * @type {number}
500
500
  * @memberof SavedShift
501
501
  */
502
- rosterShiftId?: number;
502
+ 'rosterShiftId'?: number;
503
503
  /**
504
504
  *
505
505
  * @type {string}
506
506
  * @memberof SavedShift
507
507
  */
508
- updatedAt?: string;
508
+ 'updatedAt'?: string;
509
509
  /**
510
510
  *
511
511
  * @type {Array<User>}
512
512
  * @memberof SavedShift
513
513
  */
514
- users?: Array<User>;
514
+ 'users'?: Array<User>;
515
+ }
516
+ /**
517
+ *
518
+ * @export
519
+ * @interface SavedShiftOrdering
520
+ */
521
+ export interface SavedShiftOrdering {
522
+ /**
523
+ *
524
+ * @type {string}
525
+ * @memberof SavedShiftOrdering
526
+ */
527
+ 'shiftName'?: string;
528
+ /**
529
+ *
530
+ * @type {Array<User>}
531
+ * @memberof SavedShiftOrdering
532
+ */
533
+ 'users'?: Array<User>;
534
+ }
535
+ /**
536
+ *
537
+ * @export
538
+ * @interface SavedShiftResponse
539
+ */
540
+ export interface SavedShiftResponse {
541
+ /**
542
+ *
543
+ * @type {Array<SavedShiftOrdering>}
544
+ * @memberof SavedShiftResponse
545
+ */
546
+ 'savedShiftOrdering'?: Array<SavedShiftOrdering>;
547
+ /**
548
+ *
549
+ * @type {Array<SavedShift>}
550
+ * @memberof SavedShiftResponse
551
+ */
552
+ 'savedShifts'?: Array<SavedShift>;
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<SavedShiftResponse>>;
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<SavedShiftResponse>;
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<SavedShiftResponse, any, {}>>;
1370
1408
  /**
1371
1409
  *
1372
1410
  * @summary Save a specific roster