@gewis/grooster-backend-ts 1.0.1 → 1.2.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.
Files changed (29) hide show
  1. package/package.json +3 -2
  2. package/src/.openapi-generator/FILES +0 -1
  3. package/src/api.ts +2118 -3096
  4. package/src/base.ts +28 -33
  5. package/src/common.ts +76 -128
  6. package/src/configuration.ts +95 -117
  7. package/src/docs/AuthApi.md +45 -33
  8. package/src/docs/GormDeletedAt.md +8 -7
  9. package/src/docs/Organ.md +15 -15
  10. package/src/docs/Roster.md +28 -27
  11. package/src/docs/RosterAnswer.md +20 -19
  12. package/src/docs/RosterAnswerApi.md +45 -37
  13. package/src/docs/RosterAnswerCreateRequest.md +12 -11
  14. package/src/docs/RosterAnswerUpdateRequest.md +6 -5
  15. package/src/docs/RosterApi.md +188 -128
  16. package/src/docs/RosterCreateRequest.md +12 -11
  17. package/src/docs/RosterShift.md +16 -15
  18. package/src/docs/RosterShiftApi.md +43 -29
  19. package/src/docs/RosterShiftCreateRequest.md +8 -7
  20. package/src/docs/RosterTemplate.md +18 -15
  21. package/src/docs/RosterTemplateCreateRequest.md +10 -7
  22. package/src/docs/RosterUpdateRequest.md +8 -7
  23. package/src/docs/SavedShift.md +20 -19
  24. package/src/docs/SavedShiftApi.md +69 -48
  25. package/src/docs/SavedShiftUpdateRequest.md +6 -5
  26. package/src/docs/User.md +18 -17
  27. package/src/docs/UserApi.md +82 -58
  28. package/src/docs/UserCreateRequest.md +10 -9
  29. package/src/index.ts +4 -2
package/src/docs/UserApi.md CHANGED
@@ -1,16 +1,15 @@
1
1
  # UserApi
2
2
 
3
- All URIs are relative to _http://localhost_
3
+ All URIs are relative to *http://localhost*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------------------------------------- | --------------------- | ------------------------------------- |
7
- | [**userCreatePost**](#usercreatepost) | **POST** /user/create | CreateRoster a new user |
8
- | [**userGet**](#userget) | **GET** /user/ | Get all users with optional filtering |
9
- | [**userIdDelete**](#useriddelete) | **DELETE** /user/{id} | DeleteRoster a user |
10
- | [**userIdGet**](#useridget) | **GET** /user/{id} | Get user by ID |
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**userCreatePost**](#usercreatepost) | **POST** /user/create | CreateRoster a new user|
8
+ |[**userGet**](#userget) | **GET** /user/ | Get all users with optional filtering|
9
+ |[**userIdDelete**](#useriddelete) | **DELETE** /user/{id} | DeleteRoster a user|
10
+ |[**userIdGet**](#useridget) | **GET** /user/{id} | Get user by ID|
11
11
 
12
12
  # **userCreatePost**
13
-
14
13
  > User userCreatePost(createParams)
15
14
 
16
15
  create user
@@ -18,21 +17,28 @@ create user
18
17
  ### Example
19
18
 
20
19
  ```typescript
21
- import { UserApi, Configuration, UserCreateRequest } from "./api";
20
+ import {
21
+ UserApi,
22
+ Configuration,
23
+ UserCreateRequest
24
+ } from './api';
22
25
 
23
26
  const configuration = new Configuration();
24
27
  const apiInstance = new UserApi(configuration);
25
28
 
26
29
  let createParams: UserCreateRequest; //User input
27
30
 
28
- const { status, data } = await apiInstance.userCreatePost(createParams);
31
+ const { status, data } = await apiInstance.userCreatePost(
32
+ createParams
33
+ );
29
34
  ```
30
35
 
31
36
  ### Parameters
32
37
 
33
- | Name | Type | Description | Notes |
34
- | ---------------- | --------------------- | ----------- | ----- |
35
- | **createParams** | **UserCreateRequest** | User input | |
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **createParams** | **UserCreateRequest**| User input | |
41
+
36
42
 
37
43
  ### Return type
38
44
 
@@ -44,20 +50,19 @@ const { status, data } = await apiInstance.userCreatePost(createParams);
44
50
 
45
51
  ### HTTP request headers
46
52
 
47
- - **Content-Type**: application/json
48
- - **Accept**: application/json
53
+ - **Content-Type**: application/json
54
+ - **Accept**: application/json
49
55
 
50
- ### HTTP response details
51
56
 
57
+ ### HTTP response details
52
58
  | Status code | Description | Response headers |
53
- | ----------- | ----------- | ---------------- |
54
- | **200** | OK | - |
55
- | **400** | Bad Request | - |
59
+ |-------------|-------------|------------------|
60
+ |**200** | OK | - |
61
+ |**400** | Bad Request | - |
56
62
 
57
63
  [[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)
58
64
 
59
65
  # **userGet**
60
-
61
66
  > Array<User> userGet()
62
67
 
63
68
  Retrieve a list of users with optional query parameter filtering
@@ -65,7 +70,10 @@ Retrieve a list of users with optional query parameter filtering
65
70
  ### Example
66
71
 
67
72
  ```typescript
68
- import { UserApi, Configuration } from "./api";
73
+ import {
74
+ UserApi,
75
+ Configuration
76
+ } from './api';
69
77
 
70
78
  const configuration = new Configuration();
71
79
  const apiInstance = new UserApi(configuration);
@@ -73,15 +81,19 @@ const apiInstance = new UserApi(configuration);
73
81
  let organId: number; //Organ ID (optional) (default to undefined)
74
82
  let gewisId: number; //GEWIS ID (optional) (default to undefined)
75
83
 
76
- const { status, data } = await apiInstance.userGet(organId, gewisId);
84
+ const { status, data } = await apiInstance.userGet(
85
+ organId,
86
+ gewisId
87
+ );
77
88
  ```
78
89
 
79
90
  ### Parameters
80
91
 
81
- | Name | Type | Description | Notes |
82
- | ----------- | ------------ | ----------- | -------------------------------- |
83
- | **organId** | [**number**] | Organ ID | (optional) defaults to undefined |
84
- | **gewisId** | [**number**] | GEWIS ID | (optional) defaults to undefined |
92
+ |Name | Type | Description | Notes|
93
+ |------------- | ------------- | ------------- | -------------|
94
+ | **organId** | [**number**] | Organ ID | (optional) defaults to undefined|
95
+ | **gewisId** | [**number**] | GEWIS ID | (optional) defaults to undefined|
96
+
85
97
 
86
98
  ### Return type
87
99
 
@@ -93,40 +105,46 @@ const { status, data } = await apiInstance.userGet(organId, gewisId);
93
105
 
94
106
  ### HTTP request headers
95
107
 
96
- - **Content-Type**: Not defined
97
- - **Accept**: application/json
108
+ - **Content-Type**: Not defined
109
+ - **Accept**: application/json
98
110
 
99
- ### HTTP response details
100
111
 
112
+ ### HTTP response details
101
113
  | Status code | Description | Response headers |
102
- | ----------- | ----------- | ---------------- |
103
- | **200** | OK | - |
104
- | **400** | Bad Request | - |
114
+ |-------------|-------------|------------------|
115
+ |**200** | OK | - |
116
+ |**400** | Bad Request | - |
105
117
 
106
118
  [[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)
107
119
 
108
120
  # **userIdDelete**
109
-
110
121
  > string userIdDelete()
111
122
 
123
+
112
124
  ### Example
113
125
 
114
126
  ```typescript
115
- import { UserApi, Configuration } from "./api";
127
+ import {
128
+ UserApi,
129
+ Configuration
130
+ } from './api';
116
131
 
117
132
  const configuration = new Configuration();
118
133
  const apiInstance = new UserApi(configuration);
119
134
 
120
135
  let id: number; //User ID (default to undefined)
121
136
 
122
- const { status, data } = await apiInstance.userIdDelete(id);
137
+ const { status, data } = await apiInstance.userIdDelete(
138
+ id
139
+ );
123
140
  ```
124
141
 
125
142
  ### Parameters
126
143
 
127
- | Name | Type | Description | Notes |
128
- | ------ | ------------ | ----------- | --------------------- |
129
- | **id** | [**number**] | User ID | defaults to undefined |
144
+ |Name | Type | Description | Notes|
145
+ |------------- | ------------- | ------------- | -------------|
146
+ | **id** | [**number**] | User ID | defaults to undefined|
147
+
130
148
 
131
149
  ### Return type
132
150
 
@@ -138,21 +156,20 @@ const { status, data } = await apiInstance.userIdDelete(id);
138
156
 
139
157
  ### HTTP request headers
140
158
 
141
- - **Content-Type**: Not defined
142
- - **Accept**: application/json
159
+ - **Content-Type**: Not defined
160
+ - **Accept**: application/json
143
161
 
144
- ### HTTP response details
145
162
 
163
+ ### HTTP response details
146
164
  | Status code | Description | Response headers |
147
- | ----------- | ----------- | ---------------- |
148
- | **200** | OK | - |
149
- | **400** | Bad Request | - |
150
- | **404** | Not Found | - |
165
+ |-------------|-------------|------------------|
166
+ |**200** | OK | - |
167
+ |**400** | Bad Request | - |
168
+ |**404** | Not Found | - |
151
169
 
152
170
  [[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)
153
171
 
154
172
  # **userIdGet**
155
-
156
173
  > User userIdGet()
157
174
 
158
175
  Retrieve a specific user by their unique ID
@@ -160,21 +177,27 @@ Retrieve a specific user by their unique ID
160
177
  ### Example
161
178
 
162
179
  ```typescript
163
- import { UserApi, Configuration } from "./api";
180
+ import {
181
+ UserApi,
182
+ Configuration
183
+ } from './api';
164
184
 
165
185
  const configuration = new Configuration();
166
186
  const apiInstance = new UserApi(configuration);
167
187
 
168
188
  let id: number; //User ID (default to undefined)
169
189
 
170
- const { status, data } = await apiInstance.userIdGet(id);
190
+ const { status, data } = await apiInstance.userIdGet(
191
+ id
192
+ );
171
193
  ```
172
194
 
173
195
  ### Parameters
174
196
 
175
- | Name | Type | Description | Notes |
176
- | ------ | ------------ | ----------- | --------------------- |
177
- | **id** | [**number**] | User ID | defaults to undefined |
197
+ |Name | Type | Description | Notes|
198
+ |------------- | ------------- | ------------- | -------------|
199
+ | **id** | [**number**] | User ID | defaults to undefined|
200
+
178
201
 
179
202
  ### Return type
180
203
 
@@ -186,15 +209,16 @@ const { status, data } = await apiInstance.userIdGet(id);
186
209
 
187
210
  ### HTTP request headers
188
211
 
189
- - **Content-Type**: Not defined
190
- - **Accept**: application/json
212
+ - **Content-Type**: Not defined
213
+ - **Accept**: application/json
191
214
 
192
- ### HTTP response details
193
215
 
216
+ ### HTTP response details
194
217
  | Status code | Description | Response headers |
195
- | ----------- | ----------- | ---------------- |
196
- | **200** | OK | - |
197
- | **400** | Bad Request | - |
198
- | **404** | Not Found | - |
218
+ |-------------|-------------|------------------|
219
+ |**200** | OK | - |
220
+ |**400** | Bad Request | - |
221
+ |**404** | Not Found | - |
199
222
 
200
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)
224
+
package/src/docs/UserCreateRequest.md CHANGED
@@ -1,22 +1,23 @@
1
1
  # UserCreateRequest
2
2
 
3
+
3
4
  ## Properties
4
5
 
5
- | Name | Type | Description | Notes |
6
- | ----------- | ---------------------------------- | ----------- | --------------------------------- |
7
- | **gewisid** | **number** | | [optional] [default to undefined] |
8
- | **name** | **string** | | [optional] [default to undefined] |
9
- | **organs** | [**Array&lt;Organ&gt;**](Organ.md) | | [optional] [default to undefined] |
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **gewisid** | **number** | | [optional] [default to undefined]
9
+ **name** | **string** | | [optional] [default to undefined]
10
+ **organs** | [**Array&lt;Organ&gt;**](Organ.md) | | [optional] [default to undefined]
10
11
 
11
12
  ## Example
12
13
 
13
14
  ```typescript
14
- import { UserCreateRequest } from "./api";
15
+ import { UserCreateRequest } from './api';
15
16
 
16
17
  const instance: UserCreateRequest = {
17
- gewisid,
18
- name,
19
- organs,
18
+ gewisid,
19
+ name,
20
+ organs,
20
21
  };
21
22
  ```
22
23
 
package/src/index.ts CHANGED
@@ -1,16 +1,18 @@
1
1
  /* tslint:disable */
2
-
2
+ /* eslint-disable */
3
3
  /**
4
4
  * GRooster
5
5
  * A GEWIS Rooster maker
6
6
  *
7
7
  * The version of the OpenAPI document: 0.1
8
- *
8
+ *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
14
 
15
+
15
16
  export * from "./api";
16
17
  export * from "./configuration";
18
+