@gewis/grooster-backend-ts 1.3.3 → 1.4.0

package/src/base.ts

@@ -1,86 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * GRooster
- * A GEWIS Rooster maker
- *
- * The version of the OpenAPI document: 0.1
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-import type { Configuration } from './configuration';
-// Some imports not used depending on template conditions
-// @ts-ignore
-import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
-import globalAxios from 'axios';
-
-export const BASE_PATH = "http://localhost".replace(/\/+$/, "");
-
-/**
- *
- * @export
- */
-export const COLLECTION_FORMATS = {
-    csv: ",",
-    ssv: " ",
-    tsv: "\t",
-    pipes: "|",
-};
-
-/**
- *
- * @export
- * @interface RequestArgs
- */
-export interface RequestArgs {
-    url: string;
-    options: RawAxiosRequestConfig;
-}
-
-/**
- *
- * @export
- * @class BaseAPI
- */
-export class BaseAPI {
-    protected configuration: Configuration | undefined;
-
-    constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
-        if (configuration) {
-            this.configuration = configuration;
-            this.basePath = configuration.basePath ?? basePath;
-        }
-    }
-};
-
-/**
- *
- * @export
- * @class RequiredError
- * @extends {Error}
- */
-export class RequiredError extends Error {
-    constructor(public field: string, msg?: string) {
-        super(msg);
-        this.name = "RequiredError"
-    }
-}
-
-interface ServerMap {
-    [key: string]: {
-        url: string,
-        description: string,
-    }[];
-}
-
-/**
- *
- * @export
- */
-export const operationServerMap: ServerMap = {
-}

package/src/common.ts

@@ -1,150 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * GRooster
- * A GEWIS Rooster maker
- *
- * The version of the OpenAPI document: 0.1
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-
-import type { Configuration } from "./configuration";
-import type { RequestArgs } from "./base";
-import type { AxiosInstance, AxiosResponse } from 'axios';
-import { RequiredError } from "./base";
-
-/**
- *
- * @export
- */
-export const DUMMY_BASE_URL = 'https://example.com'
-
-/**
- *
- * @throws {RequiredError}
- * @export
- */
-export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
-    if (paramValue === null || paramValue === undefined) {
-        throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
-    }
-}
-
-/**
- *
- * @export
- */
-export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
-    if (configuration && configuration.apiKey) {
-        const localVarApiKeyValue = typeof configuration.apiKey === 'function'
-            ? await configuration.apiKey(keyParamName)
-            : await configuration.apiKey;
-        object[keyParamName] = localVarApiKeyValue;
-    }
-}
-
-/**
- *
- * @export
- */
-export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
-    if (configuration && (configuration.username || configuration.password)) {
-        object["auth"] = { username: configuration.username, password: configuration.password };
-    }
-}
-
-/**
- *
- * @export
- */
-export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
-    if (configuration && configuration.accessToken) {
-        const accessToken = typeof configuration.accessToken === 'function'
-            ? await configuration.accessToken()
-            : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + accessToken;
-    }
-}
-
-/**
- *
- * @export
- */
-export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
-    if (configuration && configuration.accessToken) {
-        const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
-            ? await configuration.accessToken(name, scopes)
-            : await configuration.accessToken;
-        object["Authorization"] = "Bearer " + localVarAccessTokenValue;
-    }
-}
-
-function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
-    if (parameter == null) return;
-    if (typeof parameter === "object") {
-        if (Array.isArray(parameter)) {
-            (parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
-        }
-        else {
-            Object.keys(parameter).forEach(currentKey =>
-                setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
-            );
-        }
-    }
-    else {
-        if (urlSearchParams.has(key)) {
-            urlSearchParams.append(key, parameter);
-        }
-        else {
-            urlSearchParams.set(key, parameter);
-        }
-    }
-}
-
-/**
- *
- * @export
- */
-export const setSearchParams = function (url: URL, ...objects: any[]) {
-    const searchParams = new URLSearchParams(url.search);
-    setFlattenedQueryParams(searchParams, objects);
-    url.search = searchParams.toString();
-}
-
-/**
- *
- * @export
- */
-export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
-    const nonString = typeof value !== 'string';
-    const needsSerialization = nonString && configuration && configuration.isJsonMime
-        ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
-        : nonString;
-    return needsSerialization
-        ? JSON.stringify(value !== undefined ? value : {})
-        : (value || "");
-}
-
-/**
- *
- * @export
- */
-export const toPathString = function (url: URL) {
-    return url.pathname + url.search + url.hash
-}
-
-/**
- *
- * @export
- */
-export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
-    return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
-        const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
-        return axios.request<T, R>(axiosRequestArgs);
-    };
-}

package/src/docs/AuthApi.md

@@ -1,117 +0,0 @@
-# AuthApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**authCallbackGet**](#authcallbackget) | **GET** /auth/callback | Handle OAuth2 Callback|
-|[**authRedirectGet**](#authredirectget) | **GET** /auth/redirect | Redirect to OIDC provider|
-
-# **authCallbackGet**
-> { [key: string]: string; } authCallbackGet()
-
-Validates state, exchanges code for token, and returns user info
-
-### Example
-
-```typescript
-import {
-    AuthApi,
-    Configuration
-} from './api';
-
-const configuration = new Configuration();
-const apiInstance = new AuthApi(configuration);
-
-let state: string; //State returned from provider (default to undefined)
-let code: string; //Authorization code from provider (default to undefined)
-
-const { status, data } = await apiInstance.authCallbackGet(
-    state,
-    code
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **state** | [**string**] | State returned from provider | defaults to undefined|
-| **code** | [**string**] | Authorization code from provider | defaults to undefined|
-
-
-### Return type
-
-**{ [key: string]: string; }**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: */*
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | User info and token |  -  |
-|**400** | Bad request: missing or invalid state |  -  |
-|**500** | Internal server error |  -  |
-
-[[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)
-
-# **authRedirectGet**
-> string authRedirectGet()
-
-Generates state, sets a cookie, and redirects to Google OIDC
-
-### Example
-
-```typescript
-import {
-    AuthApi,
-    Configuration
-} from './api';
-
-const configuration = new Configuration();
-const apiInstance = new AuthApi(configuration);
-
-let state: string; //State returned from provider (default to undefined)
-
-const { status, data } = await apiInstance.authRedirectGet(
-    state
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **state** | [**string**] | State returned from provider | defaults to undefined|
-
-
-### Return type
-
-**string**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: */*
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | redirect |  -  |
-|**500** | pkg server error |  -  |
-
-[[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/GormDeletedAt.md

@@ -1,22 +0,0 @@
-# GormDeletedAt
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**time** | **string** |  | [optional] [default to undefined]
-**valid** | **boolean** | Valid is true if Time is not NULL | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { GormDeletedAt } from './api';
-
-const instance: GormDeletedAt = {
-    time,
-    valid,
-};
-```
-
-[[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/Organ.md

@@ -1,31 +0,0 @@
-# Organ
-
-An organ that users can be part of.
-
-## 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]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**users** | [**Array<User>**](User.md) |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Organ } from './api';
-
-const instance: Organ = {
-    createdAt,
-    deletedAt,
-    id,
-    name,
-    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/Roster.md

@@ -1,42 +0,0 @@
-# Roster
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**createdAt** | **string** |  | [optional] [default to undefined]
-**date** | **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]
-**organ** | [**Organ**](Organ.md) |  | [optional] [default to undefined]
-**organId** | **number** |  | [optional] [default to undefined]
-**rosterAnswer** | [**Array<RosterAnswer>**](RosterAnswer.md) |  | [optional] [default to undefined]
-**rosterShift** | [**Array<RosterShift>**](RosterShift.md) |  | [optional] [default to undefined]
-**saved** | **boolean** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**values** | **Array<string>** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { Roster } from './api';
-
-const instance: Roster = {
-    createdAt,
-    date,
-    deletedAt,
-    id,
-    name,
-    organ,
-    organId,
-    rosterAnswer,
-    rosterShift,
-    saved,
-    updatedAt,
-    values,
-};
-```
-
-[[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/RosterAnswer.md

@@ -1,34 +0,0 @@
-# RosterAnswer
-
-
-## 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]
-**rosterShiftId** | **number** |  | [optional] [default to undefined]
-**updatedAt** | **string** |  | [optional] [default to undefined]
-**userId** | **number** |  | [optional] [default to undefined]
-**value** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RosterAnswer } from './api';
-
-const instance: RosterAnswer = {
-    createdAt,
-    deletedAt,
-    id,
-    rosterId,
-    rosterShiftId,
-    updatedAt,
-    userId,
-    value,
-};
-```
-
-[[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/RosterAnswerApi.md

@@ -1,117 +0,0 @@
-# RosterAnswerApi
-
-All URIs are relative to *http://localhost*
-
-|Method | HTTP request | Description|
-|------------- | ------------- | -------------|
-|[**createRosterAnswer**](#createrosteranswer) | **POST** /roster/answer | Create a new roster shift answer|
-|[**updateRosterAnswer**](#updaterosteranswer) | **PATCH** /roster/answer/{id} | Updates a roster answer with the new value|
-
-# **createRosterAnswer**
-> RosterAnswer createRosterAnswer(createParams)
-
-
-### Example
-
-```typescript
-import {
-    RosterAnswerApi,
-    Configuration,
-    RosterAnswerCreateRequest
-} from './api';
-
-const configuration = new Configuration();
-const apiInstance = new RosterAnswerApi(configuration);
-
-let createParams: RosterAnswerCreateRequest; //Roster answer input
-
-const { status, data } = await apiInstance.createRosterAnswer(
-    createParams
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **createParams** | **RosterAnswerCreateRequest**| Roster answer input | |
-
-
-### Return type
-
-**RosterAnswer**
-
-### 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)
-
-# **updateRosterAnswer**
-> RosterAnswer updateRosterAnswer(updateParams)
-
-
-### Example
-
-```typescript
-import {
-    RosterAnswerApi,
-    Configuration,
-    RosterAnswerUpdateRequest
-} from './api';
-
-const configuration = new Configuration();
-const apiInstance = new RosterAnswerApi(configuration);
-
-let id: number; //Roster Answer ID (default to undefined)
-let updateParams: RosterAnswerUpdateRequest; //New answer value
-
-const { status, data } = await apiInstance.updateRosterAnswer(
-    id,
-    updateParams
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **updateParams** | **RosterAnswerUpdateRequest**| New answer value | |
-| **id** | [**number**] | Roster Answer ID | defaults to undefined|
-
-
-### Return type
-
-**RosterAnswer**
-
-### 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 |  -  |
-|**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/RosterAnswerCreateRequest.md

@@ -1,26 +0,0 @@
-# RosterAnswerCreateRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**rosterId** | **number** |  | [optional] [default to undefined]
-**rosterShiftId** | **number** |  | [optional] [default to undefined]
-**userId** | **number** |  | [optional] [default to undefined]
-**value** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RosterAnswerCreateRequest } from './api';
-
-const instance: RosterAnswerCreateRequest = {
-    rosterId,
-    rosterShiftId,
-    userId,
-    value,
-};
-```
-
-[[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/RosterAnswerUpdateRequest.md

@@ -1,20 +0,0 @@
-# RosterAnswerUpdateRequest
-
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**value** | **string** |  | [optional] [default to undefined]
-
-## Example
-
-```typescript
-import { RosterAnswerUpdateRequest } from './api';
-
-const instance: RosterAnswerUpdateRequest = {
-    value,
-};
-```
-
-[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)