@gewis/grooster-backend-ts 1.3.3 → 1.4.0

package/src/docs/RosterShiftCreateRequest.md

@@ -1,22 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-# 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]
-**name** | **string** |  | [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,
-    name,
-    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

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

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

@@ -1,22 +0,0 @@
-# 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

@@ -1,34 +0,0 @@
-# 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

@@ -1,170 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-# 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

@@ -1,32 +0,0 @@
-# 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

@@ -1,224 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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)

package/src/git_push.sh

@@ -1,57 +0,0 @@
-#!/bin/sh
-# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
-#
-# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
-
-git_user_id=$1
-git_repo_id=$2
-release_note=$3
-git_host=$4
-
-if [ "$git_host" = "" ]; then
-    git_host="github.com"
-    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
-fi
-
-if [ "$git_user_id" = "" ]; then
-    git_user_id="GIT_USER_ID"
-    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
-fi
-
-if [ "$git_repo_id" = "" ]; then
-    git_repo_id="GIT_REPO_ID"
-    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
-fi
-
-if [ "$release_note" = "" ]; then
-    release_note="Minor update"
-    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
-fi
-
-# Initialize the local directory as a Git repository
-git init
-
-# Adds the files in the local repository and stages them for commit.
-git add .
-
-# Commits the tracked changes and prepares them to be pushed to a remote repository.
-git commit -m "$release_note"
-
-# Sets the new remote
-git_remote=$(git remote)
-if [ "$git_remote" = "" ]; then # git remote not defined
-
-    if [ "$GIT_TOKEN" = "" ]; then
-        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
-        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
-    else
-        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
-    fi
-
-fi
-
-git pull origin master
-
-# Pushes (Forces) the changes in the local repository up to the remote repository
-echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
-git push origin master 2>&1 | grep -v 'To https'

package/tsconfig.eslint.json

@@ -1,5 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": ["**/*.ts"],
-  "exclude": ["node_modules"]
-}