@gewis/grooster-backend-ts 1.0.1

package/src/docs/RosterShiftApi.md

@@ -0,0 +1,98 @@
+# RosterShiftApi
+
+All URIs are relative to _http://localhost_
+
+| Method                                      | HTTP request                  | Description               |
+| ------------------------------------------- | ----------------------------- | ------------------------- |
+| [**createRosterShift**](#createrostershift) | **POST** /roster/shift        | Create a new roster shift |
+| [**deleteRosterShift**](#deleterostershift) | **DELETE** /roster/shift/{id} | Deletes a roster shift    |
+
+# **createRosterShift**
+
+> RosterShift createRosterShift(createParams)
+
+### Example
+
+```typescript
+import { RosterShiftApi, Configuration, RosterShiftCreateRequest } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new RosterShiftApi(configuration);
+
+let createParams: RosterShiftCreateRequest; //Roster shift input
+
+const { status, data } = await apiInstance.createRosterShift(createParams);
+```
+
+### Parameters
+
+| Name             | Type                         | Description        | Notes |
+| ---------------- | ---------------------------- | ------------------ | ----- |
+| **createParams** | **RosterShiftCreateRequest** | Roster shift input |       |
+
+### Return type
+
+**RosterShift**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+| ----------- | ----------- | ---------------- |
+| **200**     | OK          | -                |
+| **400**     | Bad Request | -                |
+
+[[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)
+
+# **deleteRosterShift**
+
+> string deleteRosterShift()
+
+### Example
+
+```typescript
+import { RosterShiftApi, Configuration } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new RosterShiftApi(configuration);
+
+let id: number; //Roster Answer ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteRosterShift(id);
+```
+
+### Parameters
+
+| Name   | Type         | Description      | Notes                 |
+| ------ | ------------ | ---------------- | --------------------- |
+| **id** | [**number**] | Roster Answer ID | defaults to undefined |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+| ----------- | ----------- | ---------------- |
+| **200**     | OK          | -                |
+| **400**     | Bad Request | -                |
+
+[[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)

package/src/docs/RosterShiftCreateRequest.md

@@ -0,0 +1,21 @@
+# RosterShiftCreateRequest
+
+## Properties
+
+| Name         | Type       | Description | Notes                             |
+| ------------ | ---------- | ----------- | --------------------------------- |
+| **name**     | **string** |             | [optional] [default to undefined] |
+| **rosterId** | **number** |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { RosterShiftCreateRequest } from "./api";
+
+const instance: RosterShiftCreateRequest = {
+  name,
+  rosterId,
+};
+```
+
+[[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/RosterTemplate.md

@@ -0,0 +1,29 @@
+# RosterTemplate
+
+## Properties
+
+| Name          | Type                                  | Description | Notes                             |
+| ------------- | ------------------------------------- | ----------- | --------------------------------- |
+| **createdAt** | **string**                            |             | [optional] [default to undefined] |
+| **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) |             | [optional] [default to undefined] |
+| **id**        | **number**                            |             | [optional] [default to undefined] |
+| **organId**   | **number**                            |             | [optional] [default to undefined] |
+| **shifts**    | **Array<string>**               |             | [optional] [default to undefined] |
+| **updatedAt** | **string**                            |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { RosterTemplate } from "./api";
+
+const instance: RosterTemplate = {
+  createdAt,
+  deletedAt,
+  id,
+  organId,
+  shifts,
+  updatedAt,
+};
+```
+
+[[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/RosterTemplateCreateRequest.md

@@ -0,0 +1,21 @@
+# RosterTemplateCreateRequest
+
+## Properties
+
+| Name        | Type                    | Description | Notes                             |
+| ----------- | ----------------------- | ----------- | --------------------------------- |
+| **organId** | **number**              |             | [optional] [default to undefined] |
+| **shifts**  | **Array<string>** |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { RosterTemplateCreateRequest } from "./api";
+
+const instance: RosterTemplateCreateRequest = {
+  organId,
+  shifts,
+};
+```
+
+[[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/RosterUpdateRequest.md

@@ -0,0 +1,21 @@
+# RosterUpdateRequest
+
+## Properties
+
+| Name     | Type       | Description | Notes                             |
+| -------- | ---------- | ----------- | --------------------------------- |
+| **date** | **string** |             | [optional] [default to undefined] |
+| **name** | **string** |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { RosterUpdateRequest } from "./api";
+
+const instance: RosterUpdateRequest = {
+  date,
+  name,
+};
+```
+
+[[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/SavedShift.md

@@ -0,0 +1,33 @@
+# SavedShift
+
+## Properties
+
+| Name              | Type                                  | Description | Notes                             |
+| ----------------- | ------------------------------------- | ----------- | --------------------------------- |
+| **createdAt**     | **string**                            |             | [optional] [default to undefined] |
+| **deletedAt**     | [**GormDeletedAt**](GormDeletedAt.md) |             | [optional] [default to undefined] |
+| **id**            | **number**                            |             | [optional] [default to undefined] |
+| **rosterId**      | **number**                            |             | [optional] [default to undefined] |
+| **rosterShift**   | [**RosterShift**](RosterShift.md)     |             | [optional] [default to undefined] |
+| **rosterShiftId** | **number**                            |             | [optional] [default to undefined] |
+| **updatedAt**     | **string**                            |             | [optional] [default to undefined] |
+| **users**         | [**Array<User>**](User.md)      |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { SavedShift } from "./api";
+
+const instance: SavedShift = {
+  createdAt,
+  deletedAt,
+  id,
+  rosterId,
+  rosterShift,
+  rosterShiftId,
+  updatedAt,
+  users,
+};
+```
+
+[[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/SavedShiftApi.md

@@ -0,0 +1,149 @@
+# SavedShiftApi
+
+All URIs are relative to _http://localhost_
+
+| Method                                    | HTTP request                       | Description                                |
+| ----------------------------------------- | ---------------------------------- | ------------------------------------------ |
+| [**getSavedRoster**](#getsavedroster)     | **GET** /roster/saved-shift/{id}   | Get all saved shifts for a specific roster |
+| [**rosterSave**](#rostersave)             | **POST** /roster/{id}/save         | Save a specific roster                     |
+| [**updateSavedShift**](#updatesavedshift) | **PATCH** /roster/saved-shift/{id} | Update a specific saved shift              |
+
+# **getSavedRoster**
+
+> Array<SavedShift> getSavedRoster()
+
+### Example
+
+```typescript
+import { SavedShiftApi, Configuration } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new SavedShiftApi(configuration);
+
+let id: number; //Roster ID (default to undefined)
+
+const { status, data } = await apiInstance.getSavedRoster(id);
+```
+
+### Parameters
+
+| Name   | Type         | Description | Notes                 |
+| ------ | ------------ | ----------- | --------------------- |
+| **id** | [**number**] | Roster ID   | defaults to undefined |
+
+### Return type
+
+**Array<SavedShift>**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description          | Response headers |
+| ----------- | -------------------- | ---------------- |
+| **200**     | Saved Shifts         | -                |
+| **400**     | Invalid request      | -                |
+| **404**     | SavedShift not found | -                |
+
+[[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)
+
+# **rosterSave**
+
+> string rosterSave()
+
+### Example
+
+```typescript
+import { SavedShiftApi, Configuration } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new SavedShiftApi(configuration);
+
+let id: number; //Roster ID (default to undefined)
+
+const { status, data } = await apiInstance.rosterSave(id);
+```
+
+### Parameters
+
+| Name   | Type         | Description | Notes                 |
+| ------ | ------------ | ----------- | --------------------- |
+| **id** | [**number**] | Roster ID   | defaults to undefined |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+| ----------- | ----------- | ---------------- |
+| **200**     | OK          | -                |
+| **400**     | Bad Request | -                |
+| **404**     | Not Found   | -                |
+
+[[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)
+
+# **updateSavedShift**
+
+> SavedShift updateSavedShift(updateParams)
+
+### Example
+
+```typescript
+import { SavedShiftApi, Configuration, SavedShiftUpdateRequest } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new SavedShiftApi(configuration);
+
+let id: number; //SavedShift ID (default to undefined)
+let updateParams: SavedShiftUpdateRequest; //Update data
+
+const { status, data } = await apiInstance.updateSavedShift(id, updateParams);
+```
+
+### Parameters
+
+| Name             | Type                        | Description   | Notes                 |
+| ---------------- | --------------------------- | ------------- | --------------------- |
+| **updateParams** | **SavedShiftUpdateRequest** | Update data   |                       |
+| **id**           | [**number**]                | SavedShift ID | defaults to undefined |
+
+### Return type
+
+**SavedShift**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description          | Response headers |
+| ----------- | -------------------- | ---------------- |
+| **200**     | OK                   | -                |
+| **400**     | Invalid request      | -                |
+| **404**     | SavedShift not found | -                |
+
+[[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)

package/src/docs/SavedShiftUpdateRequest.md

@@ -0,0 +1,19 @@
+# SavedShiftUpdateRequest
+
+## Properties
+
+| Name      | Type                    | Description | Notes                             |
+| --------- | ----------------------- | ----------- | --------------------------------- |
+| **users** | **Array<number>** |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { SavedShiftUpdateRequest } from "./api";
+
+const instance: SavedShiftUpdateRequest = {
+  users,
+};
+```
+
+[[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/User.md

@@ -0,0 +1,31 @@
+# User
+
+## Properties
+
+| Name          | Type                                  | Description | Notes                             |
+| ------------- | ------------------------------------- | ----------- | --------------------------------- |
+| **createdAt** | **string**                            |             | [optional] [default to undefined] |
+| **deletedAt** | [**GormDeletedAt**](GormDeletedAt.md) |             | [optional] [default to undefined] |
+| **gewis_id**  | **number**                            |             | [optional] [default to undefined] |
+| **id**        | **number**                            |             | [optional] [default to undefined] |
+| **name**      | **string**                            |             | [optional] [default to undefined] |
+| **organs**    | [**Array<Organ>**](Organ.md)    |             | [optional] [default to undefined] |
+| **updatedAt** | **string**                            |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { User } from "./api";
+
+const instance: User = {
+  createdAt,
+  deletedAt,
+  gewis_id,
+  id,
+  name,
+  organs,
+  updatedAt,
+};
+```
+
+[[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/UserApi.md

@@ -0,0 +1,200 @@
+# UserApi
+
+All URIs are relative to _http://localhost_
+
+| Method                                | HTTP request          | Description                           |
+| ------------------------------------- | --------------------- | ------------------------------------- |
+| [**userCreatePost**](#usercreatepost) | **POST** /user/create | CreateRoster a new user               |
+| [**userGet**](#userget)               | **GET** /user/        | Get all users with optional filtering |
+| [**userIdDelete**](#useriddelete)     | **DELETE** /user/{id} | DeleteRoster a user                   |
+| [**userIdGet**](#useridget)           | **GET** /user/{id}    | Get user by ID                        |
+
+# **userCreatePost**
+
+> User userCreatePost(createParams)
+
+create user
+
+### Example
+
+```typescript
+import { UserApi, Configuration, UserCreateRequest } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let createParams: UserCreateRequest; //User input
+
+const { status, data } = await apiInstance.userCreatePost(createParams);
+```
+
+### Parameters
+
+| Name             | Type                  | Description | Notes |
+| ---------------- | --------------------- | ----------- | ----- |
+| **createParams** | **UserCreateRequest** | User input  |       |
+
+### Return type
+
+**User**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+| ----------- | ----------- | ---------------- |
+| **200**     | OK          | -                |
+| **400**     | Bad Request | -                |
+
+[[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)
+
+# **userGet**
+
+> Array<User> userGet()
+
+Retrieve a list of users with optional query parameter filtering
+
+### Example
+
+```typescript
+import { UserApi, Configuration } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let organId: number; //Organ ID (optional) (default to undefined)
+let gewisId: number; //GEWIS ID (optional) (default to undefined)
+
+const { status, data } = await apiInstance.userGet(organId, gewisId);
+```
+
+### Parameters
+
+| Name        | Type         | Description | Notes                            |
+| ----------- | ------------ | ----------- | -------------------------------- |
+| **organId** | [**number**] | Organ ID    | (optional) defaults to undefined |
+| **gewisId** | [**number**] | GEWIS ID    | (optional) defaults to undefined |
+
+### Return type
+
+**Array<User>**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+| ----------- | ----------- | ---------------- |
+| **200**     | OK          | -                |
+| **400**     | Bad Request | -                |
+
+[[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)
+
+# **userIdDelete**
+
+> string userIdDelete()
+
+### Example
+
+```typescript
+import { UserApi, Configuration } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let id: number; //User ID (default to undefined)
+
+const { status, data } = await apiInstance.userIdDelete(id);
+```
+
+### Parameters
+
+| Name   | Type         | Description | Notes                 |
+| ------ | ------------ | ----------- | --------------------- |
+| **id** | [**number**] | User ID     | defaults to undefined |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+| ----------- | ----------- | ---------------- |
+| **200**     | OK          | -                |
+| **400**     | Bad Request | -                |
+| **404**     | Not Found   | -                |
+
+[[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)
+
+# **userIdGet**
+
+> User userIdGet()
+
+Retrieve a specific user by their unique ID
+
+### Example
+
+```typescript
+import { UserApi, Configuration } from "./api";
+
+const configuration = new Configuration();
+const apiInstance = new UserApi(configuration);
+
+let id: number; //User ID (default to undefined)
+
+const { status, data } = await apiInstance.userIdGet(id);
+```
+
+### Parameters
+
+| Name   | Type         | Description | Notes                 |
+| ------ | ------------ | ----------- | --------------------- |
+| **id** | [**number**] | User ID     | defaults to undefined |
+
+### Return type
+
+**User**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+| ----------- | ----------- | ---------------- |
+| **200**     | OK          | -                |
+| **400**     | Bad Request | -                |
+| **404**     | Not Found   | -                |
+
+[[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)

package/src/docs/UserCreateRequest.md

@@ -0,0 +1,23 @@
+# UserCreateRequest
+
+## Properties
+
+| Name        | Type                               | Description | Notes                             |
+| ----------- | ---------------------------------- | ----------- | --------------------------------- |
+| **gewisid** | **number**                         |             | [optional] [default to undefined] |
+| **name**    | **string**                         |             | [optional] [default to undefined] |
+| **organs**  | [**Array<Organ>**](Organ.md) |             | [optional] [default to undefined] |
+
+## Example
+
+```typescript
+import { UserCreateRequest } from "./api";
+
+const instance: UserCreateRequest = {
+  gewisid,
+  name,
+  organs,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)