new lib version [CI SKIP]

dist/core/OpenAPI.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAPI = void 0;
 exports.OpenAPI = {
     BASE: '',
-    VERSION: '1.0.0',
+    VERSION: '0.0.5',
     WITH_CREDENTIALS: false,
     TOKEN: undefined,
     USERNAME: undefined,

dist/index.d.ts

@@ -7,6 +7,7 @@ export type { Auth } from './models/Auth';
 export type { CreateAuth } from './models/CreateAuth';
 export type { CreateParticipant } from './models/CreateParticipant';
 export { CreatePermission } from './models/CreatePermission';
+export type { CreateResetToken } from './models/CreateResetToken';
 export type { CreateRunner } from './models/CreateRunner';
 export type { CreateRunnerGroup } from './models/CreateRunnerGroup';
 export type { CreateRunnerOrganisation } from './models/CreateRunnerOrganisation';
@@ -39,6 +40,8 @@ export type { PrincipalNotFoundError } from './models/PrincipalNotFoundError';
 export type { PrincipalWrongTypeError } from './models/PrincipalWrongTypeError';
 export type { RefreshAuth } from './models/RefreshAuth';
 export type { RefreshTokenCountInvalidError } from './models/RefreshTokenCountInvalidError';
+export type { ResetAlreadyRequestedError } from './models/ResetAlreadyRequestedError';
+export type { ResetPassword } from './models/ResetPassword';
 export type { ResponseEmpty } from './models/ResponseEmpty';
 export type { ResponseParticipant } from './models/ResponseParticipant';
 export { ResponsePermission } from './models/ResponsePermission';
@@ -81,6 +84,7 @@ export type { UpdateRunnerTeam } from './models/UpdateRunnerTeam';
 export type { UpdateUser } from './models/UpdateUser';
 export type { User } from './models/User';
 export { UserAction } from './models/UserAction';
+export type { UserDisabledError } from './models/UserDisabledError';
 export type { UserGroup } from './models/UserGroup';
 export type { UserGroupIdsNotMatchingError } from './models/UserGroupIdsNotMatchingError';
 export type { UserGroupNotFoundError } from './models/UserGroupNotFoundError';

dist/models/CreateResetToken.d.ts

@@ -0,0 +1,4 @@
+export declare type CreateResetToken = {
+    username?: string;
+    email?: string;
+};

dist/models/CreateResetToken.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/CreateUser.d.ts

@@ -6,5 +6,6 @@ export declare type CreateUser = {
     email?: string;
     phone?: string;
     password: string;
+    enabled?: boolean;
     groups?: any;
 };

dist/models/ResetAlreadyRequestedError.d.ts

@@ -0,0 +1,4 @@
+export declare type ResetAlreadyRequestedError = {
+    name: string;
+    message: string;
+};

dist/models/ResetAlreadyRequestedError.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/ResetPassword.d.ts

@@ -0,0 +1,4 @@
+export declare type ResetPassword = {
+    resetToken?: string;
+    password: string;
+};

dist/models/ResetPassword.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/models/User.d.ts

@@ -11,6 +11,7 @@ export declare type User = {
     enabled: boolean;
     refreshTokenCount: number;
     profilePic?: string;
+    resetRequestedTimestamp?: string;
     actions?: any;
     id: number;
 };

dist/models/UserDisabledError.d.ts

@@ -0,0 +1,4 @@
+export declare type UserDisabledError = {
+    name: string;
+    message: string;
+};

dist/models/UserDisabledError.js

@@ -0,0 +1,5 @@
+"use strict";
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });

dist/services/AuthService.d.ts

@@ -1,5 +1,6 @@
 import type { Auth } from '../models/Auth';
 import type { CreateAuth } from '../models/CreateAuth';
+import type { CreateResetToken } from '../models/CreateResetToken';
 import type { HandleLogout } from '../models/HandleLogout';
 import type { IllegalJWTError } from '../models/IllegalJWTError';
 import type { InvalidCredentialsError } from '../models/InvalidCredentialsError';
@@ -8,12 +9,15 @@ import type { Logout } from '../models/Logout';
 import type { PasswordNeededError } from '../models/PasswordNeededError';
 import type { RefreshAuth } from '../models/RefreshAuth';
 import type { RefreshTokenCountInvalidError } from '../models/RefreshTokenCountInvalidError';
+import type { ResetPassword } from '../models/ResetPassword';
 import type { UsernameOrEmailNeededError } from '../models/UsernameOrEmailNeededError';
 import type { UserNotFoundError } from '../models/UserNotFoundError';
 export declare class AuthService {
     /**
      * Login
-     * Create a new access token object
+     * Login with your username/email and password. <br> You will receive:
+     * * access token (use it as a bearer token)
+     * * refresh token (will also be sent as a cookie)
      * @param requestBody CreateAuth
      * @returns any
      * @throws ApiError
@@ -21,7 +25,7 @@ export declare class AuthService {
     static authControllerLogin(requestBody?: CreateAuth): Promise<(Auth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
     /**
      * Logout
-     * Create a new access token object
+     * Logout using your refresh token. <br> This instantly invalidates all your access and refresh tokens.
      * @param requestBody HandleLogout
      * @returns any
      * @throws ApiError
@@ -29,10 +33,29 @@ export declare class AuthService {
     static authControllerLogout(requestBody?: HandleLogout): Promise<(Logout | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
     /**
      * Refresh
-     * refresh a access token
+     * Refresh your access and refresh tokens using a valid refresh token. <br> You will receive:
+     * * access token (use it as a bearer token)
+     * * refresh token (will also be sent as a cookie)
      * @param requestBody RefreshAuth
      * @returns any
      * @throws ApiError
      */
     static authControllerRefresh(requestBody?: RefreshAuth): Promise<(Auth | JwtNotProvidedError | IllegalJWTError | UserNotFoundError | RefreshTokenCountInvalidError)>;
+    /**
+     * Get reset token
+     * Request a password reset token. <br> This will provide you with a reset token that you can use by posting to /api/auth/reset/{token}.
+     * @param requestBody CreateResetToken
+     * @returns any
+     * @throws ApiError
+     */
+    static authControllerGetResetToken(requestBody?: CreateResetToken): Promise<(Auth | UserNotFoundError | UsernameOrEmailNeededError)>;
+    /**
+     * Reset password
+     * Reset a user's utilising a valid password reset token. <br> This will set the user's password to the one you provided in the body. <br> To get a reset token post to /api/auth/reset with your username.
+     * @param token
+     * @param requestBody ResetPassword
+     * @returns any
+     * @throws ApiError
+     */
+    static authControllerResetPassword(token: string, requestBody?: ResetPassword): Promise<(Auth | UserNotFoundError | UsernameOrEmailNeededError)>;
 }

dist/services/AuthService.js

@@ -5,7 +5,9 @@ const request_1 = require("../core/request");
 class AuthService {
     /**
      * Login
-     * Create a new access token object
+     * Login with your username/email and password. <br> You will receive:
+     * * access token (use it as a bearer token)
+     * * refresh token (will also be sent as a cookie)
      * @param requestBody CreateAuth
      * @returns any
      * @throws ApiError
@@ -20,7 +22,7 @@ class AuthService {
     }
     /**
      * Logout
-     * Create a new access token object
+     * Logout using your refresh token. <br> This instantly invalidates all your access and refresh tokens.
      * @param requestBody HandleLogout
      * @returns any
      * @throws ApiError
@@ -35,7 +37,9 @@ class AuthService {
     }
     /**
      * Refresh
-     * refresh a access token
+     * Refresh your access and refresh tokens using a valid refresh token. <br> You will receive:
+     * * access token (use it as a bearer token)
+     * * refresh token (will also be sent as a cookie)
      * @param requestBody RefreshAuth
      * @returns any
      * @throws ApiError
@@ -48,5 +52,36 @@ class AuthService {
         });
         return result.body;
     }
+    /**
+     * Get reset token
+     * Request a password reset token. <br> This will provide you with a reset token that you can use by posting to /api/auth/reset/{token}.
+     * @param requestBody CreateResetToken
+     * @returns any
+     * @throws ApiError
+     */
+    static async authControllerGetResetToken(requestBody) {
+        const result = await request_1.request({
+            method: 'POST',
+            path: `/api/auth/reset`,
+            body: requestBody,
+        });
+        return result.body;
+    }
+    /**
+     * Reset password
+     * Reset a user's utilising a valid password reset token. <br> This will set the user's password to the one you provided in the body. <br> To get a reset token post to /api/auth/reset with your username.
+     * @param token
+     * @param requestBody ResetPassword
+     * @returns any
+     * @throws ApiError
+     */
+    static async authControllerResetPassword(token, requestBody) {
+        const result = await request_1.request({
+            method: 'POST',
+            path: `/api/auth/reset/${token}`,
+            body: requestBody,
+        });
+        return result.body;
+    }
 }
 exports.AuthService = AuthService;

dist/services/ImportService.d.ts

@@ -3,7 +3,7 @@ import type { ResponseRunner } from '../models/ResponseRunner';
 export declare class ImportService {
     /**
      * Post json
-     * Create new runners from json and insert them (or their teams) into the provided group
+     * Create new runners from json and insert them into the provided group. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param group
      * @param requestBody ImportRunner
      * @returns ResponseRunner
@@ -12,7 +12,7 @@ export declare class ImportService {
     static importControllerPostJson(group?: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
     /**
      * Post orgs json
-     * Create new runners from json and insert them (or their teams) into the provided org
+     * Create new runners from json and insert them into the provided org. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param id
      * @param requestBody ImportRunner
      * @returns ResponseRunner
@@ -30,7 +30,7 @@ export declare class ImportService {
     static importControllerPostTeamsJson(id: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
     /**
      * Post csv
-     * Create new runners from csv and insert them (or their teams) into the provided group
+     * Create new runners from csv and insert them into the provided group. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param group
      * @returns ResponseRunner
      * @throws ApiError
@@ -38,7 +38,7 @@ export declare class ImportService {
     static importControllerPostCsv(group?: number): Promise<Array<ResponseRunner>>;
     /**
      * Post orgs csv
-     * Create new runners from csv and insert them (or their teams) into the provided org
+     * Create new runners from csv and insert them into the provided org. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param id
      * @returns ResponseRunner
      * @throws ApiError

dist/services/ImportService.js

@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
 class ImportService {
     /**
      * Post json
-     * Create new runners from json and insert them (or their teams) into the provided group
+     * Create new runners from json and insert them into the provided group. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param group
      * @param requestBody ImportRunner
      * @returns ResponseRunner
@@ -24,7 +24,7 @@ class ImportService {
     }
     /**
      * Post orgs json
-     * Create new runners from json and insert them (or their teams) into the provided org
+     * Create new runners from json and insert them into the provided org. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param id
      * @param requestBody ImportRunner
      * @returns ResponseRunner
@@ -56,7 +56,7 @@ class ImportService {
     }
     /**
      * Post csv
-     * Create new runners from csv and insert them (or their teams) into the provided group
+     * Create new runners from csv and insert them into the provided group. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param group
      * @returns ResponseRunner
      * @throws ApiError
@@ -73,7 +73,7 @@ class ImportService {
     }
     /**
      * Post orgs csv
-     * Create new runners from csv and insert them (or their teams) into the provided org
+     * Create new runners from csv and insert them into the provided org. <br> If teams/classes are provided alongside the runner's name they'll automaticly be created under the provided org and the runners will be inserted into the teams instead.
      * @param id
      * @returns ResponseRunner
      * @throws ApiError

dist/services/PermissionService.d.ts

@@ -6,14 +6,14 @@ import type { UpdatePermission } from '../models/UpdatePermission';
 export declare class PermissionService {
     /**
      * Get all
-     * Lists all permissions.
+     * Lists all permissions for all users and groups.
      * @returns ResponsePermission
      * @throws ApiError
      */
     static permissionControllerGetAll(): Promise<Array<ResponsePermission>>;
     /**
      * Post
-     * Create a new runnerTeam object (id will be generated automagicly).
+     * Create a new permission for a existing principal(user/group). <br> If a permission with this target, action and prinicpal already exists that permission will be returned instead of creating a new one.
      * @param requestBody CreatePermission
      * @returns ResponsePermission
      * @throws ApiError
@@ -21,7 +21,7 @@ export declare class PermissionService {
     static permissionControllerPost(requestBody?: CreatePermission): Promise<ResponsePermission>;
     /**
      * Get one
-     * Returns a permissions of a specified id (if it exists)
+     * Lists all information about the permission whose id got provided.
      * @param id
      * @returns ResponsePermission
      * @throws ApiError
@@ -29,7 +29,7 @@ export declare class PermissionService {
     static permissionControllerGetOne(id: number): Promise<ResponsePermission>;
     /**
      * Put
-     * Update a permission object (id can't be changed).
+     * Update a permission object. <br> If updateing the permission object would result in duplicate permission (same target, action and principal) this permission will get deleted and the existing permission will be returned. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdatePermission
      * @returns ResponsePrincipal
@@ -38,7 +38,7 @@ export declare class PermissionService {
     static permissionControllerPut(id: number, requestBody?: UpdatePermission): Promise<ResponsePrincipal>;
     /**
      * Remove
-     * Delete a specified permission (if it exists).
+     * Deletes the permission whose id you provide. <br> If no permission with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponsePermission

dist/services/PermissionService.js

@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
 class PermissionService {
     /**
      * Get all
-     * Lists all permissions.
+     * Lists all permissions for all users and groups.
      * @returns ResponsePermission
      * @throws ApiError
      */
@@ -18,7 +18,7 @@ class PermissionService {
     }
     /**
      * Post
-     * Create a new runnerTeam object (id will be generated automagicly).
+     * Create a new permission for a existing principal(user/group). <br> If a permission with this target, action and prinicpal already exists that permission will be returned instead of creating a new one.
      * @param requestBody CreatePermission
      * @returns ResponsePermission
      * @throws ApiError
@@ -33,7 +33,7 @@ class PermissionService {
     }
     /**
      * Get one
-     * Returns a permissions of a specified id (if it exists)
+     * Lists all information about the permission whose id got provided.
      * @param id
      * @returns ResponsePermission
      * @throws ApiError
@@ -47,7 +47,7 @@ class PermissionService {
     }
     /**
      * Put
-     * Update a permission object (id can't be changed).
+     * Update a permission object. <br> If updateing the permission object would result in duplicate permission (same target, action and principal) this permission will get deleted and the existing permission will be returned. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdatePermission
      * @returns ResponsePrincipal
@@ -63,7 +63,7 @@ class PermissionService {
     }
     /**
      * Remove
-     * Delete a specified permission (if it exists).
+     * Deletes the permission whose id you provide. <br> If no permission with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponsePermission

dist/services/RunnerOrganisationService.d.ts

@@ -5,14 +5,14 @@ import type { UpdateRunnerOrganisation } from '../models/UpdateRunnerOrganisatio
 export declare class RunnerOrganisationService {
     /**
      * Get all
-     * Lists all runnerOrganisations.
+     * Lists all organisations. <br> This includes their address, contact and teams (if existing/associated).
      * @returns ResponseRunnerOrganisation
      * @throws ApiError
      */
     static runnerOrganisationControllerGetAll(): Promise<Array<ResponseRunnerOrganisation>>;
     /**
      * Post
-     * Create a new runnerOrganisation object (id will be generated automagicly).
+     * Create a new organsisation.
      * @param requestBody CreateRunnerOrganisation
      * @returns ResponseRunnerOrganisation
      * @throws ApiError
@@ -20,7 +20,7 @@ export declare class RunnerOrganisationService {
     static runnerOrganisationControllerPost(requestBody?: CreateRunnerOrganisation): Promise<ResponseRunnerOrganisation>;
     /**
      * Get one
-     * Returns a runnerOrganisation of a specified id (if it exists)
+     * Lists all information about the organisation whose id got provided.
      * @param id
      * @returns ResponseRunnerOrganisation
      * @throws ApiError
@@ -28,7 +28,7 @@ export declare class RunnerOrganisationService {
     static runnerOrganisationControllerGetOne(id: number): Promise<ResponseRunnerOrganisation>;
     /**
      * Put
-     * Update a runnerOrganisation object (id can't be changed).
+     * Update the organisation whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateRunnerOrganisation
      * @returns ResponseRunnerOrganisation
@@ -37,7 +37,7 @@ export declare class RunnerOrganisationService {
     static runnerOrganisationControllerPut(id: number, requestBody?: UpdateRunnerOrganisation): Promise<ResponseRunnerOrganisation>;
     /**
      * Remove
-     * Delete a specified runnerOrganisation (if it exists).
+     * Delete the organsisation whose id you provided. <br> If the organisation still has runners and/or teams associated this will fail. <br> To delete the organisation with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> If no organisation with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseRunnerOrganisation

dist/services/RunnerOrganisationService.js

@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
 class RunnerOrganisationService {
     /**
      * Get all
-     * Lists all runnerOrganisations.
+     * Lists all organisations. <br> This includes their address, contact and teams (if existing/associated).
      * @returns ResponseRunnerOrganisation
      * @throws ApiError
      */
@@ -18,7 +18,7 @@ class RunnerOrganisationService {
     }
     /**
      * Post
-     * Create a new runnerOrganisation object (id will be generated automagicly).
+     * Create a new organsisation.
      * @param requestBody CreateRunnerOrganisation
      * @returns ResponseRunnerOrganisation
      * @throws ApiError
@@ -33,7 +33,7 @@ class RunnerOrganisationService {
     }
     /**
      * Get one
-     * Returns a runnerOrganisation of a specified id (if it exists)
+     * Lists all information about the organisation whose id got provided.
      * @param id
      * @returns ResponseRunnerOrganisation
      * @throws ApiError
@@ -47,7 +47,7 @@ class RunnerOrganisationService {
     }
     /**
      * Put
-     * Update a runnerOrganisation object (id can't be changed).
+     * Update the organisation whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateRunnerOrganisation
      * @returns ResponseRunnerOrganisation
@@ -63,7 +63,7 @@ class RunnerOrganisationService {
     }
     /**
      * Remove
-     * Delete a specified runnerOrganisation (if it exists).
+     * Delete the organsisation whose id you provided. <br> If the organisation still has runners and/or teams associated this will fail. <br> To delete the organisation with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> If no organisation with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseRunnerOrganisation

dist/services/RunnerService.d.ts

@@ -7,14 +7,14 @@ import type { UpdateRunner } from '../models/UpdateRunner';
 export declare class RunnerService {
     /**
      * Get all
-     * Lists all runners.
+     * Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
      * @returns ResponseRunner
      * @throws ApiError
      */
     static runnerControllerGetAll(): Promise<Array<ResponseRunner>>;
     /**
      * Post
-     * Create a new runner object (id will be generated automagicly).
+     * Create a new runner. <br> Please remeber to provide the runner's group's id.
      * @param requestBody CreateRunner
      * @returns any
      * @throws ApiError
@@ -22,7 +22,7 @@ export declare class RunnerService {
     static runnerControllerPost(requestBody?: CreateRunner): Promise<(ResponseRunner | RunnerGroupNeededError | RunnerGroupNotFoundError)>;
     /**
      * Get one
-     * Returns a runner of a specified id (if it exists)
+     * Lists all information about the runner whose id got provided.
      * @param id
      * @returns ResponseRunner
      * @throws ApiError
@@ -30,7 +30,7 @@ export declare class RunnerService {
     static runnerControllerGetOne(id: number): Promise<ResponseRunner>;
     /**
      * Put
-     * Update a runner object (id can't be changed).
+     * Update the runner whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateRunner
      * @returns ResponseRunner
@@ -39,7 +39,7 @@ export declare class RunnerService {
     static runnerControllerPut(id: number, requestBody?: UpdateRunner): Promise<ResponseRunner>;
     /**
      * Remove
-     * Delete a specified runner (if it exists).
+     * Delete the runner whose id you provided. <br> If no runner with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseRunner

dist/services/RunnerService.js

@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
 class RunnerService {
     /**
      * Get all
-     * Lists all runners.
+     * Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
      * @returns ResponseRunner
      * @throws ApiError
      */
@@ -18,7 +18,7 @@ class RunnerService {
     }
     /**
      * Post
-     * Create a new runner object (id will be generated automagicly).
+     * Create a new runner. <br> Please remeber to provide the runner's group's id.
      * @param requestBody CreateRunner
      * @returns any
      * @throws ApiError
@@ -33,7 +33,7 @@ class RunnerService {
     }
     /**
      * Get one
-     * Returns a runner of a specified id (if it exists)
+     * Lists all information about the runner whose id got provided.
      * @param id
      * @returns ResponseRunner
      * @throws ApiError
@@ -47,7 +47,7 @@ class RunnerService {
     }
     /**
      * Put
-     * Update a runner object (id can't be changed).
+     * Update the runner whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateRunner
      * @returns ResponseRunner
@@ -63,7 +63,7 @@ class RunnerService {
     }
     /**
      * Remove
-     * Delete a specified runner (if it exists).
+     * Delete the runner whose id you provided. <br> If no runner with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseRunner

dist/services/RunnerTeamService.d.ts

@@ -5,14 +5,14 @@ import type { UpdateRunnerTeam } from '../models/UpdateRunnerTeam';
 export declare class RunnerTeamService {
     /**
      * Get all
-     * Lists all runnerTeams.
+     * Lists all teams. <br> This includes their parent organisation and contact (if existing/associated).
      * @returns ResponseRunnerTeam
      * @throws ApiError
      */
     static runnerTeamControllerGetAll(): Promise<Array<ResponseRunnerTeam>>;
     /**
      * Post
-     * Create a new runnerTeam object (id will be generated automagicly).
+     * Create a new organsisation. <br> Please remember to provide it's parent group's id.
      * @param requestBody CreateRunnerTeam
      * @returns ResponseRunnerTeam
      * @throws ApiError
@@ -20,7 +20,7 @@ export declare class RunnerTeamService {
     static runnerTeamControllerPost(requestBody?: CreateRunnerTeam): Promise<ResponseRunnerTeam>;
     /**
      * Get one
-     * Returns a runnerTeam of a specified id (if it exists)
+     * Lists all information about the team whose id got provided.
      * @param id
      * @returns ResponseRunnerTeam
      * @throws ApiError
@@ -28,7 +28,7 @@ export declare class RunnerTeamService {
     static runnerTeamControllerGetOne(id: number): Promise<ResponseRunnerTeam>;
     /**
      * Put
-     * Update a runnerTeam object (id can't be changed).
+     * Update the team whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateRunnerTeam
      * @returns ResponseRunnerTeam
@@ -37,7 +37,7 @@ export declare class RunnerTeamService {
     static runnerTeamControllerPut(id: number, requestBody?: UpdateRunnerTeam): Promise<ResponseRunnerTeam>;
     /**
      * Remove
-     * Delete a specified runnerTeam (if it exists).
+     * Delete the team whose id you provided. <br> If the team still has runners associated this will fail. <br> To delete the team with all associated runners set the force QueryParam to true (cascading deletion might take a while). <br> If no team with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseRunnerTeam

dist/services/RunnerTeamService.js

@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
 class RunnerTeamService {
     /**
      * Get all
-     * Lists all runnerTeams.
+     * Lists all teams. <br> This includes their parent organisation and contact (if existing/associated).
      * @returns ResponseRunnerTeam
      * @throws ApiError
      */
@@ -18,7 +18,7 @@ class RunnerTeamService {
     }
     /**
      * Post
-     * Create a new runnerTeam object (id will be generated automagicly).
+     * Create a new organsisation. <br> Please remember to provide it's parent group's id.
      * @param requestBody CreateRunnerTeam
      * @returns ResponseRunnerTeam
      * @throws ApiError
@@ -33,7 +33,7 @@ class RunnerTeamService {
     }
     /**
      * Get one
-     * Returns a runnerTeam of a specified id (if it exists)
+     * Lists all information about the team whose id got provided.
      * @param id
      * @returns ResponseRunnerTeam
      * @throws ApiError
@@ -47,7 +47,7 @@ class RunnerTeamService {
     }
     /**
      * Put
-     * Update a runnerTeam object (id can't be changed).
+     * Update the team whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateRunnerTeam
      * @returns ResponseRunnerTeam
@@ -63,7 +63,7 @@ class RunnerTeamService {
     }
     /**
      * Remove
-     * Delete a specified runnerTeam (if it exists).
+     * Delete the team whose id you provided. <br> If the team still has runners associated this will fail. <br> To delete the team with all associated runners set the force QueryParam to true (cascading deletion might take a while). <br> If no team with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseRunnerTeam

dist/services/StatusService.d.ts

@@ -1,7 +1,7 @@
 export declare class StatusService {
     /**
      * Get
-     * Lists all tracks.
+     * A very basic status/health endpoint that just checks if the database connection is available. <br> The available information depth will be expanded later.
      * @returns any Successful response
      * @throws ApiError
      */

dist/services/StatusService.js

@@ -8,7 +8,7 @@ const request_1 = require("../core/request");
 class StatusService {
     /**
      * Get
-     * Lists all tracks.
+     * A very basic status/health endpoint that just checks if the database connection is available. <br> The available information depth will be expanded later.
      * @returns any Successful response
      * @throws ApiError
      */

dist/services/TrackService.d.ts

@@ -5,13 +5,14 @@ import type { Track } from '../models/Track';
 export declare class TrackService {
     /**
      * Get all
+     * Lists all tracks.
      * @returns ResponseTrack
      * @throws ApiError
      */
     static trackControllerGetAll(): Promise<Array<ResponseTrack>>;
     /**
      * Post
-     * Create a new track object (id will be generated automagicly).
+     * Create a new track. <br> Please remember that the track's distance must be greater than 0.
      * @param requestBody CreateTrack
      * @returns ResponseTrack
      * @throws ApiError
@@ -19,7 +20,7 @@ export declare class TrackService {
     static trackControllerPost(requestBody?: CreateTrack): Promise<ResponseTrack>;
     /**
      * Get one
-     * Returns a track of a specified id (if it exists)
+     * Lists all information about the track whose id got provided.
      * @param id
      * @returns ResponseTrack
      * @throws ApiError
@@ -27,7 +28,7 @@ export declare class TrackService {
     static trackControllerGetOne(id: number): Promise<ResponseTrack>;
     /**
      * Put
-     * Update a track object (id can't be changed).
+     * Update the track whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody Track
      * @returns ResponseTrack
@@ -36,7 +37,7 @@ export declare class TrackService {
     static trackControllerPut(id: number, requestBody?: Track): Promise<ResponseTrack>;
     /**
      * Remove
-     * Delete a specified track (if it exists).
+     * Delete the track whose id you provided. <br> If no track with this id exists it will just return 204(no content).
      * @param id
      * @returns ResponseTrack
      * @returns ResponseEmpty

dist/services/TrackService.js

@@ -5,6 +5,7 @@ const request_1 = require("../core/request");
 class TrackService {
     /**
      * Get all
+     * Lists all tracks.
      * @returns ResponseTrack
      * @throws ApiError
      */
@@ -17,7 +18,7 @@ class TrackService {
     }
     /**
      * Post
-     * Create a new track object (id will be generated automagicly).
+     * Create a new track. <br> Please remember that the track's distance must be greater than 0.
      * @param requestBody CreateTrack
      * @returns ResponseTrack
      * @throws ApiError
@@ -32,7 +33,7 @@ class TrackService {
     }
     /**
      * Get one
-     * Returns a track of a specified id (if it exists)
+     * Lists all information about the track whose id got provided.
      * @param id
      * @returns ResponseTrack
      * @throws ApiError
@@ -46,7 +47,7 @@ class TrackService {
     }
     /**
      * Put
-     * Update a track object (id can't be changed).
+     * Update the track whose id you provided. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody Track
      * @returns ResponseTrack
@@ -62,7 +63,7 @@ class TrackService {
     }
     /**
      * Remove
-     * Delete a specified track (if it exists).
+     * Delete the track whose id you provided. <br> If no track with this id exists it will just return 204(no content).
      * @param id
      * @returns ResponseTrack
      * @returns ResponseEmpty

dist/services/UserGroupService.d.ts

@@ -6,14 +6,14 @@ import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
 export declare class UserGroupService {
     /**
      * Get all
-     * Lists all usergroups.
+     * Lists all groups. <br> The information provided might change while the project continues to evolve.
      * @returns UserGroup
      * @throws ApiError
      */
     static userGroupControllerGetAll(): Promise<Array<UserGroup>>;
     /**
      * Post
-     * Create a new usergroup object (id will be generated automagicly).
+     * Create a new group. <br> If you want to grant permissions to the group you have to create them seperately by posting to /api/permissions after creating the group.
      * @param requestBody CreateUserGroup
      * @returns any
      * @throws ApiError
@@ -21,7 +21,7 @@ export declare class UserGroupService {
     static userGroupControllerPost(requestBody?: CreateUserGroup): Promise<(UserGroup | UserGroupNotFoundError)>;
     /**
      * Get one
-     * Returns a usergroup of a specified id (if it exists)
+     * Lists all information about the group whose id got provided. <br> The information provided might change while the project continues to evolve.
      * @param id
      * @returns UserGroup
      * @throws ApiError
@@ -29,7 +29,7 @@ export declare class UserGroupService {
     static userGroupControllerGetOne(id: number): Promise<UserGroup>;
     /**
      * Put
-     * Update a usergroup object (id can't be changed).
+     * Update the group whose id you provided. <br> To change the permissions granted to the group please use /api/permissions instead. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UserGroup
      * @returns UserGroup
@@ -38,7 +38,7 @@ export declare class UserGroupService {
     static userGroupControllerPut(id: number, requestBody?: UserGroup): Promise<UserGroup>;
     /**
      * Remove
-     * Delete a specified usergroup (if it exists).
+     * Delete the group whose id you provided. <br> If there are any permissions directly granted to the group they will get deleted as well. <br> Users associated with this group won't get deleted - just deassociated. <br> If no group with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseUserGroup

dist/services/UserGroupService.js

@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
 class UserGroupService {
     /**
      * Get all
-     * Lists all usergroups.
+     * Lists all groups. <br> The information provided might change while the project continues to evolve.
      * @returns UserGroup
      * @throws ApiError
      */
@@ -18,7 +18,7 @@ class UserGroupService {
     }
     /**
      * Post
-     * Create a new usergroup object (id will be generated automagicly).
+     * Create a new group. <br> If you want to grant permissions to the group you have to create them seperately by posting to /api/permissions after creating the group.
      * @param requestBody CreateUserGroup
      * @returns any
      * @throws ApiError
@@ -33,7 +33,7 @@ class UserGroupService {
     }
     /**
      * Get one
-     * Returns a usergroup of a specified id (if it exists)
+     * Lists all information about the group whose id got provided. <br> The information provided might change while the project continues to evolve.
      * @param id
      * @returns UserGroup
      * @throws ApiError
@@ -47,7 +47,7 @@ class UserGroupService {
     }
     /**
      * Put
-     * Update a usergroup object (id can't be changed).
+     * Update the group whose id you provided. <br> To change the permissions granted to the group please use /api/permissions instead. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UserGroup
      * @returns UserGroup
@@ -63,7 +63,7 @@ class UserGroupService {
     }
     /**
      * Remove
-     * Delete a specified usergroup (if it exists).
+     * Delete the group whose id you provided. <br> If there are any permissions directly granted to the group they will get deleted as well. <br> Users associated with this group won't get deleted - just deassociated. <br> If no group with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns ResponseUserGroup

dist/services/UserService.d.ts

@@ -6,14 +6,14 @@ import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
 export declare class UserService {
     /**
      * Get all
-     * Lists all users.
+     * Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
      * @returns User
      * @throws ApiError
      */
     static userControllerGetAll(): Promise<Array<User>>;
     /**
      * Post
-     * Create a new user object (id will be generated automagicly).
+     * Create a new user. <br> If you want to grant permissions to the user you have to create them seperately by posting to /api/permissions after creating the user.
      * @param requestBody CreateUser
      * @returns any
      * @throws ApiError
@@ -21,7 +21,7 @@ export declare class UserService {
     static userControllerPost(requestBody?: CreateUser): Promise<(User | UserGroupNotFoundError)>;
     /**
      * Get one
-     * Returns a user of a specified id (if it exists)
+     * Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
      * @param id
      * @returns User
      * @throws ApiError
@@ -29,7 +29,7 @@ export declare class UserService {
     static userControllerGetOne(id: number): Promise<User>;
     /**
      * Put
-     * Update a user object (id can't be changed).
+     * Update the user whose id you provided. <br> To change the permissions directly granted to the user please use /api/permissions instead. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateUser
      * @returns User
@@ -38,7 +38,7 @@ export declare class UserService {
     static userControllerPut(id: number, requestBody?: UpdateUser): Promise<User>;
     /**
      * Remove
-     * Delete a user runner (if it exists).
+     * Delete the user whose id you provided. <br> If there are any permissions directly granted to the user they will get deleted as well. <br> If no user with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns User

dist/services/UserService.js

@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
 class UserService {
     /**
      * Get all
-     * Lists all users.
+     * Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
      * @returns User
      * @throws ApiError
      */
@@ -18,7 +18,7 @@ class UserService {
     }
     /**
      * Post
-     * Create a new user object (id will be generated automagicly).
+     * Create a new user. <br> If you want to grant permissions to the user you have to create them seperately by posting to /api/permissions after creating the user.
      * @param requestBody CreateUser
      * @returns any
      * @throws ApiError
@@ -33,7 +33,7 @@ class UserService {
     }
     /**
      * Get one
-     * Returns a user of a specified id (if it exists)
+     * Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
      * @param id
      * @returns User
      * @throws ApiError
@@ -47,7 +47,7 @@ class UserService {
     }
     /**
      * Put
-     * Update a user object (id can't be changed).
+     * Update the user whose id you provided. <br> To change the permissions directly granted to the user please use /api/permissions instead. <br> Please remember that ids can't be changed.
      * @param id
      * @param requestBody UpdateUser
      * @returns User
@@ -63,7 +63,7 @@ class UserService {
     }
     /**
      * Remove
-     * Delete a user runner (if it exists).
+     * Delete the user whose id you provided. <br> If there are any permissions directly granted to the user they will get deleted as well. <br> If no user with this id exists it will just return 204(no content).
      * @param id
      * @param force
      * @returns User