lfk
/
lfk-client-js
3
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

🚀New lib version v0.13.1 [CI SKIP]
continuous-integration/drone Build is passing Details

This commit is contained in:
Nicolai Ort 2023-02-02 15:19:00 +00:00
parent ad90844846
commit 9b6d686d93
45 changed files with 271 additions and 274 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dist/core/OpenAPI.js vendored
View File

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

2
dist/core/request.d.ts vendored
View File

@ -3,7 +3,7 @@ import type { ApiResult } from './ApiResult';
/**
* Request using fetch client
* @param options The request options from the the service
* @returns ApiResult
* @result ApiResult
* @throws ApiError
*/
export declare function request(options: ApiRequestOptions): Promise<ApiResult>;

5
dist/core/request.js vendored
View File

@ -111,9 +111,6 @@ async function sendRequest(options, url) {
headers: await getHeaders(options),
body: getRequestBody(options),
};
if (OpenAPI_1.OpenAPI.WITH_CREDENTIALS) {
request.credentials = 'include';
}
return await fetch(url, request);
}
function getResponseHeader(response, responseHeader) {
@ -165,7 +162,7 @@ function catchErrors(options, result) {
/**
* Request using fetch client
* @param options The request options from the the service
* @returns ApiResult
* @result ApiResult
* @throws ApiError
*/
async function request(options) {

22
dist/services/AuthService.d.ts vendored
View File

@ -17,28 +17,28 @@ export declare class AuthService {
/**
* Login
* 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)
* * access token (use it as a bearer token)
* * refresh token (will also be sent as a cookie)
* @param requestBody CreateAuth
* @returns any
* @result any
* @throws ApiError
*/
static authControllerLogin(requestBody?: CreateAuth): Promise<(ResponseAuth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
static authControllerLogin(requestBody?: CreateAuth): Promise<(ResponseAuth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError | InvalidCredentialsError)>;
/**
* Logout
* Logout using your refresh token. <br> This instantly invalidates all your access and refresh tokens.
* @param requestBody HandleLogout
* @returns any
* @result any
* @throws ApiError
*/
static authControllerLogout(requestBody?: HandleLogout): Promise<(Logout | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
static authControllerLogout(requestBody?: HandleLogout): Promise<(Logout | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError | InvalidCredentialsError)>;
/**
* Refresh
* 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)
* * access token (use it as a bearer token)
* * refresh token (will also be sent as a cookie)
* @param requestBody RefreshAuth
* @returns any
* @result any
* @throws ApiError
*/
static authControllerRefresh(requestBody?: RefreshAuth): Promise<(ResponseAuth | JwtNotProvidedError | IllegalJWTError | UserNotFoundError | RefreshTokenCountInvalidError)>;
@ -47,7 +47,7 @@ export declare class AuthService {
* 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 locale
* @param requestBody CreateResetToken
* @returns ResponseEmpty
* @result ResponseEmpty
* @throws ApiError
*/
static authControllerGetResetToken(locale?: string, requestBody?: CreateResetToken): Promise<ResponseEmpty>;
@ -56,7 +56,7 @@ export declare class AuthService {
* 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
* @result any
* @throws ApiError
*/
static authControllerResetPassword(token: string, requestBody?: ResetPassword): Promise<(ResponseAuth | UserNotFoundError | UsernameOrEmailNeededError)>;

18
dist/services/AuthService.js vendored
View File

@ -6,10 +6,10 @@ class AuthService {
/**
* Login
* 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)
* * access token (use it as a bearer token)
* * refresh token (will also be sent as a cookie)
* @param requestBody CreateAuth
* @returns any
* @result any
* @throws ApiError
*/
static async authControllerLogin(requestBody) {
@ -24,7 +24,7 @@ class AuthService {
* Logout
* Logout using your refresh token. <br> This instantly invalidates all your access and refresh tokens.
* @param requestBody HandleLogout
* @returns any
* @result any
* @throws ApiError
*/
static async authControllerLogout(requestBody) {
@ -38,10 +38,10 @@ class AuthService {
/**
* Refresh
* 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)
* * access token (use it as a bearer token)
* * refresh token (will also be sent as a cookie)
* @param requestBody RefreshAuth
* @returns any
* @result any
* @throws ApiError
*/
static async authControllerRefresh(requestBody) {
@ -57,7 +57,7 @@ class AuthService {
* 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 locale
* @param requestBody CreateResetToken
* @returns ResponseEmpty
* @result ResponseEmpty
* @throws ApiError
*/
static async authControllerGetResetToken(locale, requestBody) {
@ -76,7 +76,7 @@ class AuthService {
* 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
* @result any
* @throws ApiError
*/
static async authControllerResetPassword(token, requestBody) {

16
dist/services/DonationService.d.ts vendored
View File

@ -9,7 +9,7 @@ export declare class DonationService {
/**
* Get all
* Lists all donations (fixed or distance based) from all donors. <br> This includes the donations's runner's distance ran(if distance donation).
* @returns any
* @result any
* @throws ApiError
*/
static donationControllerGetAll(): Promise<(Array<ResponseDonation> | Array<ResponseDistanceDonation>)>;
@ -17,7 +17,7 @@ export declare class DonationService {
* Get one
* Lists all information about the donation whose id got provided. This includes the donation's runner's distance ran (if distance donation).
* @param id
* @returns any
* @result any
* @throws ApiError
*/
static donationControllerGetOne(id: number): Promise<(ResponseDonation | ResponseDistanceDonation)>;
@ -26,8 +26,8 @@ export declare class DonationService {
* Delete the donation whose id you provided. <br> If no donation with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns any
* @returns ResponseEmpty
* @result any
* @result ResponseEmpty
* @throws ApiError
*/
static donationControllerRemove(id: number, force?: boolean): Promise<(ResponseDonation | ResponseDistanceDonation) | ResponseEmpty>;
@ -35,7 +35,7 @@ export declare class DonationService {
* Post fixed
* Create a fixed donation (not distance donation - use /donations/distance instead). <br> Please rmemember to provide the donation's donors's id and amount.
* @param requestBody CreateFixedDonation
* @returns ResponseDonation
* @result ResponseDonation
* @throws ApiError
*/
static donationControllerPostFixed(requestBody?: CreateFixedDonation): Promise<ResponseDonation>;
@ -43,7 +43,7 @@ export declare class DonationService {
* Post distance
* Create a distance donation (not fixed donation - use /donations/fixed instead). <br> Please rmemember to provide the donation's donors's and runners ids and amount per distance (kilometer).
* @param requestBody CreateDistanceDonation
* @returns ResponseDistanceDonation
* @result ResponseDistanceDonation
* @throws ApiError
*/
static donationControllerPostDistance(requestBody?: CreateDistanceDonation): Promise<ResponseDistanceDonation>;
@ -52,7 +52,7 @@ export declare class DonationService {
* Update the fixed donation (not distance donation - use /donations/distance instead) whose id you provided. <br> Please remember that ids can't be changed and amounts must be positive.
* @param id
* @param requestBody UpdateFixedDonation
* @returns ResponseDonation
* @result ResponseDonation
* @throws ApiError
*/
static donationControllerPutFixed(id: number, requestBody?: UpdateFixedDonation): Promise<ResponseDonation>;
@ -61,7 +61,7 @@ export declare class DonationService {
* Update the distance donation (not fixed donation - use /donations/fixed instead) whose id you provided. <br> Please remember that ids can't be changed and amountPerDistance must be positive.
* @param id
* @param requestBody UpdateDistanceDonation
* @returns ResponseDonation
* @result ResponseDonation
* @throws ApiError
*/
static donationControllerPutDistance(id: number, requestBody?: UpdateDistanceDonation): Promise<ResponseDonation>;

16
dist/services/DonationService.js vendored
View File

@ -6,7 +6,7 @@ class DonationService {
/**
* Get all
* Lists all donations (fixed or distance based) from all donors. <br> This includes the donations's runner's distance ran(if distance donation).
* @returns any
* @result any
* @throws ApiError
*/
static async donationControllerGetAll() {
@ -20,7 +20,7 @@ class DonationService {
* Get one
* Lists all information about the donation whose id got provided. This includes the donation's runner's distance ran (if distance donation).
* @param id
* @returns any
* @result any
* @throws ApiError
*/
static async donationControllerGetOne(id) {
@ -35,8 +35,8 @@ class DonationService {
* Delete the donation whose id you provided. <br> If no donation with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns any
* @returns ResponseEmpty
* @result any
* @result ResponseEmpty
* @throws ApiError
*/
static async donationControllerRemove(id, force) {
@ -53,7 +53,7 @@ class DonationService {
* Post fixed
* Create a fixed donation (not distance donation - use /donations/distance instead). <br> Please rmemember to provide the donation's donors's id and amount.
* @param requestBody CreateFixedDonation
* @returns ResponseDonation
* @result ResponseDonation
* @throws ApiError
*/
static async donationControllerPostFixed(requestBody) {
@ -68,7 +68,7 @@ class DonationService {
* Post distance
* Create a distance donation (not fixed donation - use /donations/fixed instead). <br> Please rmemember to provide the donation's donors's and runners ids and amount per distance (kilometer).
* @param requestBody CreateDistanceDonation
* @returns ResponseDistanceDonation
* @result ResponseDistanceDonation
* @throws ApiError
*/
static async donationControllerPostDistance(requestBody) {
@ -84,7 +84,7 @@ class DonationService {
* Update the fixed donation (not distance donation - use /donations/distance instead) whose id you provided. <br> Please remember that ids can't be changed and amounts must be positive.
* @param id
* @param requestBody UpdateFixedDonation
* @returns ResponseDonation
* @result ResponseDonation
* @throws ApiError
*/
static async donationControllerPutFixed(id, requestBody) {
@ -100,7 +100,7 @@ class DonationService {
* Update the distance donation (not fixed donation - use /donations/fixed instead) whose id you provided. <br> Please remember that ids can't be changed and amountPerDistance must be positive.
* @param id
* @param requestBody UpdateDistanceDonation
* @returns ResponseDonation
* @result ResponseDonation
* @throws ApiError
*/
static async donationControllerPutDistance(id, requestBody) {

12
dist/services/DonorService.d.ts vendored
View File

@ -6,7 +6,7 @@ export declare class DonorService {
/**
* Get all
* Lists all donor. <br> This includes the donor's current donation amount.
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerGetAll(): Promise<Array<ResponseDonor>>;
@ -14,7 +14,7 @@ export declare class DonorService {
* Post
* Create a new donor.
* @param requestBody CreateDonor
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerPost(requestBody?: CreateDonor): Promise<ResponseDonor>;
@ -22,7 +22,7 @@ export declare class DonorService {
* Get one
* Lists all information about the donor whose id got provided. <br> This includes the donor's current donation amount.
* @param id
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerGetOne(id: number): Promise<ResponseDonor>;
@ -31,7 +31,7 @@ export declare class DonorService {
* Update the donor whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateDonor
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static donorControllerPut(id: number, requestBody?: UpdateDonor): Promise<ResponseDonor>;
@ -40,8 +40,8 @@ export declare class DonorService {
* Delete the donor whose id you provided. <br> If no donor with this id exists it will just return 204(no content). <br> If the donor still has donations associated this will fail, please provide the query param ?force=true to delete the donor with all associated donations.
* @param id
* @param force
* @returns ResponseDonor
* @returns ResponseEmpty
* @result ResponseDonor
* @result ResponseEmpty
* @throws ApiError
*/
static donorControllerRemove(id: number, force?: boolean): Promise<ResponseDonor | ResponseEmpty>;

12
dist/services/DonorService.js vendored
View File

@ -6,7 +6,7 @@ class DonorService {
/**
* Get all
* Lists all donor. <br> This includes the donor's current donation amount.
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static async donorControllerGetAll() {
@ -20,7 +20,7 @@ class DonorService {
* Post
* Create a new donor.
* @param requestBody CreateDonor
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static async donorControllerPost(requestBody) {
@ -35,7 +35,7 @@ class DonorService {
* Get one
* Lists all information about the donor whose id got provided. <br> This includes the donor's current donation amount.
* @param id
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static async donorControllerGetOne(id) {
@ -50,7 +50,7 @@ class DonorService {
* Update the donor whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateDonor
* @returns ResponseDonor
* @result ResponseDonor
* @throws ApiError
*/
static async donorControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class DonorService {
* Delete the donor whose id you provided. <br> If no donor with this id exists it will just return 204(no content). <br> If the donor still has donations associated this will fail, please provide the query param ?force=true to delete the donor with all associated donations.
* @param id
* @param force
* @returns ResponseDonor
* @returns ResponseEmpty
* @result ResponseDonor
* @result ResponseEmpty
* @throws ApiError
*/
static async donorControllerRemove(id, force) {

12
dist/services/GroupContactService.d.ts vendored
View File

@ -6,7 +6,7 @@ export declare class GroupContactService {
/**
* Get all
* Lists all contacts. <br> This includes the contact's associated groups.
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static groupContactControllerGetAll(): Promise<Array<ResponseGroupContact>>;
@ -14,7 +14,7 @@ export declare class GroupContactService {
* Post
* Create a new contact.
* @param requestBody CreateGroupContact
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static groupContactControllerPost(requestBody?: CreateGroupContact): Promise<ResponseGroupContact>;
@ -22,7 +22,7 @@ export declare class GroupContactService {
* Get one
* Lists all information about the contact whose id got provided. <br> This includes the contact's associated groups.
* @param id
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static groupContactControllerGetOne(id: number): Promise<ResponseGroupContact>;
@ -31,7 +31,7 @@ export declare class GroupContactService {
* Update the contact whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateGroupContact
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static groupContactControllerPut(id: number, requestBody?: UpdateGroupContact): Promise<ResponseGroupContact>;
@ -40,8 +40,8 @@ export declare class GroupContactService {
* Delete the contact whose id you provided. <br> If no contact with this id exists it will just return 204(no content). <br> This won't delete any groups associated with the contact.
* @param id
* @param force
* @returns ResponseGroupContact
* @returns ResponseEmpty
* @result ResponseGroupContact
* @result ResponseEmpty
* @throws ApiError
*/
static groupContactControllerRemove(id: number, force?: boolean): Promise<ResponseGroupContact | ResponseEmpty>;

12
dist/services/GroupContactService.js vendored
View File

@ -6,7 +6,7 @@ class GroupContactService {
/**
* Get all
* Lists all contacts. <br> This includes the contact's associated groups.
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static async groupContactControllerGetAll() {
@ -20,7 +20,7 @@ class GroupContactService {
* Post
* Create a new contact.
* @param requestBody CreateGroupContact
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static async groupContactControllerPost(requestBody) {
@ -35,7 +35,7 @@ class GroupContactService {
* Get one
* Lists all information about the contact whose id got provided. <br> This includes the contact's associated groups.
* @param id
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static async groupContactControllerGetOne(id) {
@ -50,7 +50,7 @@ class GroupContactService {
* Update the contact whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateGroupContact
* @returns ResponseGroupContact
* @result ResponseGroupContact
* @throws ApiError
*/
static async groupContactControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class GroupContactService {
* Delete the contact whose id you provided. <br> If no contact with this id exists it will just return 204(no content). <br> This won't delete any groups associated with the contact.
* @param id
* @param force
* @returns ResponseGroupContact
* @returns ResponseEmpty
* @result ResponseGroupContact
* @result ResponseEmpty
* @throws ApiError
*/
static async groupContactControllerRemove(id, force) {

12
dist/services/ImportService.d.ts vendored
View File

@ -6,7 +6,7 @@ export declare class ImportService {
* 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
* @result ResponseRunner
* @throws ApiError
*/
static importControllerPostJson(group?: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
@ -15,7 +15,7 @@ export declare class ImportService {
* 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
* @result ResponseRunner
* @throws ApiError
*/
static importControllerPostOrgsJson(id: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
@ -24,7 +24,7 @@ export declare class ImportService {
* Create new runners from json and insert them into the provided team
* @param id
* @param requestBody ImportRunner
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static importControllerPostTeamsJson(id: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
@ -32,7 +32,7 @@ export declare class ImportService {
* Post csv
* 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
* @result ResponseRunner
* @throws ApiError
*/
static importControllerPostCsv(group?: number): Promise<Array<ResponseRunner>>;
@ -40,7 +40,7 @@ export declare class ImportService {
* Post orgs csv
* 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
* @result ResponseRunner
* @throws ApiError
*/
static importControllerPostOrgsCsv(id: number): Promise<Array<ResponseRunner>>;
@ -48,7 +48,7 @@ export declare class ImportService {
* Post teams csv
* Create new runners from csv and insert them into the provided team
* @param id
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static importControllerPostTeamsCsv(id: number): Promise<Array<ResponseRunner>>;

12
dist/services/ImportService.js vendored
View File

@ -8,7 +8,7 @@ class ImportService {
* 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
* @result ResponseRunner
* @throws ApiError
*/
static async importControllerPostJson(group, requestBody) {
@ -27,7 +27,7 @@ class ImportService {
* 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
* @result ResponseRunner
* @throws ApiError
*/
static async importControllerPostOrgsJson(id, requestBody) {
@ -43,7 +43,7 @@ class ImportService {
* Create new runners from json and insert them into the provided team
* @param id
* @param requestBody ImportRunner
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static async importControllerPostTeamsJson(id, requestBody) {
@ -58,7 +58,7 @@ class ImportService {
* Post csv
* 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
* @result ResponseRunner
* @throws ApiError
*/
static async importControllerPostCsv(group) {
@ -75,7 +75,7 @@ class ImportService {
* Post orgs csv
* 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
* @result ResponseRunner
* @throws ApiError
*/
static async importControllerPostOrgsCsv(id) {
@ -89,7 +89,7 @@ class ImportService {
* Post teams csv
* Create new runners from csv and insert them into the provided team
* @param id
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static async importControllerPostTeamsCsv(id) {

8
dist/services/MeService.d.ts vendored
View File

@ -5,7 +5,7 @@ export declare class MeService {
/**
* Get
* Lists all information about yourself.
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static meControllerGet(): Promise<ResponseUser>;
@ -13,7 +13,7 @@ export declare class MeService {
* Put
* Update the yourself. <br> You can't edit your own permissions or group memberships here - Please use the /api/users/:id enpoint instead. <br> Please remember that ids can't be changed.
* @param requestBody UpdateUser
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static meControllerPut(requestBody?: UpdateUser): Promise<ResponseUser>;
@ -21,14 +21,14 @@ export declare class MeService {
* Remove
* Delete yourself. <br> You have to confirm your decision by providing the ?force=true query param. <br> If there are any permissions directly granted to you they will get deleted as well.
* @param force
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static meControllerRemove(force?: boolean): Promise<ResponseUser>;
/**
* Get permissions
* Lists all permissions granted to the you sorted into directly granted and inherited as permission response objects.
* @returns ResponseUserPermissions
* @result ResponseUserPermissions
* @throws ApiError
*/
static meControllerGetPermissions(): Promise<ResponseUserPermissions>;

8
dist/services/MeService.js vendored
View File

@ -6,7 +6,7 @@ class MeService {
/**
* Get
* Lists all information about yourself.
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async meControllerGet() {
@ -20,7 +20,7 @@ class MeService {
* Put
* Update the yourself. <br> You can't edit your own permissions or group memberships here - Please use the /api/users/:id enpoint instead. <br> Please remember that ids can't be changed.
* @param requestBody UpdateUser
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async meControllerPut(requestBody) {
@ -35,7 +35,7 @@ class MeService {
* Remove
* Delete yourself. <br> You have to confirm your decision by providing the ?force=true query param. <br> If there are any permissions directly granted to you they will get deleted as well.
* @param force
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async meControllerRemove(force) {
@ -51,7 +51,7 @@ class MeService {
/**
* Get permissions
* Lists all permissions granted to the you sorted into directly granted and inherited as permission response objects.
* @returns ResponseUserPermissions
* @result ResponseUserPermissions
* @throws ApiError
*/
static async meControllerGetPermissions() {

12
dist/services/PermissionService.d.ts vendored
View File

@ -7,7 +7,7 @@ export declare class PermissionService {
/**
* Get all
* Lists all permissions for all users and groups.
* @returns ResponsePermission
* @result ResponsePermission
* @throws ApiError
*/
static permissionControllerGetAll(): Promise<Array<ResponsePermission>>;
@ -15,7 +15,7 @@ export declare class PermissionService {
* Post
* 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
* @result ResponsePermission
* @throws ApiError
*/
static permissionControllerPost(requestBody?: CreatePermission): Promise<ResponsePermission>;
@ -23,7 +23,7 @@ export declare class PermissionService {
* Get one
* Lists all information about the permission whose id got provided.
* @param id
* @returns ResponsePermission
* @result ResponsePermission
* @throws ApiError
*/
static permissionControllerGetOne(id: number): Promise<ResponsePermission>;
@ -32,7 +32,7 @@ export declare class PermissionService {
* 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
* @result ResponsePrincipal
* @throws ApiError
*/
static permissionControllerPut(id: number, requestBody?: UpdatePermission): Promise<ResponsePrincipal>;
@ -41,8 +41,8 @@ export declare class PermissionService {
* 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
* @returns ResponseEmpty
* @result ResponsePermission
* @result ResponseEmpty
* @throws ApiError
*/
static permissionControllerRemove(id: number, force?: boolean): Promise<ResponsePermission | ResponseEmpty>;

12
dist/services/PermissionService.js vendored
View File

@ -6,7 +6,7 @@ class PermissionService {
/**
* Get all
* Lists all permissions for all users and groups.
* @returns ResponsePermission
* @result ResponsePermission
* @throws ApiError
*/
static async permissionControllerGetAll() {
@ -20,7 +20,7 @@ class PermissionService {
* Post
* 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
* @result ResponsePermission
* @throws ApiError
*/
static async permissionControllerPost(requestBody) {
@ -35,7 +35,7 @@ class PermissionService {
* Get one
* Lists all information about the permission whose id got provided.
* @param id
* @returns ResponsePermission
* @result ResponsePermission
* @throws ApiError
*/
static async permissionControllerGetOne(id) {
@ -50,7 +50,7 @@ class PermissionService {
* 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
* @result ResponsePrincipal
* @throws ApiError
*/
static async permissionControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class PermissionService {
* 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
* @returns ResponseEmpty
* @result ResponsePermission
* @result ResponseEmpty
* @throws ApiError
*/
static async permissionControllerRemove(id, force) {

14
dist/services/RunnerCardService.d.ts vendored
View File

@ -6,7 +6,7 @@ export declare class RunnerCardService {
/**
* Get all
* Lists all card.
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static runnerCardControllerGetAll(): Promise<Array<ResponseRunnerCard>>;
@ -14,7 +14,7 @@ export declare class RunnerCardService {
* Post
* Create a new card. <br> You can provide a associated runner by id but you don't have to.
* @param requestBody CreateRunnerCard
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static runnerCardControllerPost(requestBody?: CreateRunnerCard): Promise<ResponseRunnerCard>;
@ -22,7 +22,7 @@ export declare class RunnerCardService {
* Get one
* Lists all information about the card whose id got provided.
* @param id
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static runnerCardControllerGetOne(id: number): Promise<ResponseRunnerCard>;
@ -31,7 +31,7 @@ export declare class RunnerCardService {
* Update the card whose id you provided. <br> Scans created via this card will still be associated with the old runner. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerCard
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static runnerCardControllerPut(id: number, requestBody?: UpdateRunnerCard): Promise<ResponseRunnerCard>;
@ -40,8 +40,8 @@ export declare class RunnerCardService {
* Delete the card whose id you provided. <br> If no card with this id exists it will just return 204(no content). <br> If the card still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with by this card - please disable it instead or just remove the runner association).
* @param id
* @param force
* @returns ResponseRunnerCard
* @returns ResponseEmpty
* @result ResponseRunnerCard
* @result ResponseEmpty
* @throws ApiError
*/
static runnerCardControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerCard | ResponseEmpty>;
@ -50,7 +50,7 @@ export declare class RunnerCardService {
* Create blank cards in bulk. <br> Just provide the count as a query param and wait for the 200 response. <br> You can provide the 'returnCards' query param if you want to receive the RESPONSERUNNERCARD objects in the response.
* @param count
* @param returnCards
* @returns ResponseEmpty
* @result ResponseEmpty
* @throws ApiError
*/
static runnerCardControllerPostBlancoBulk(count?: number, returnCards?: boolean): Promise<ResponseEmpty>;

14
dist/services/RunnerCardService.js vendored
View File

@ -6,7 +6,7 @@ class RunnerCardService {
/**
* Get all
* Lists all card.
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static async runnerCardControllerGetAll() {
@ -20,7 +20,7 @@ class RunnerCardService {
* Post
* Create a new card. <br> You can provide a associated runner by id but you don't have to.
* @param requestBody CreateRunnerCard
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static async runnerCardControllerPost(requestBody) {
@ -35,7 +35,7 @@ class RunnerCardService {
* Get one
* Lists all information about the card whose id got provided.
* @param id
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static async runnerCardControllerGetOne(id) {
@ -50,7 +50,7 @@ class RunnerCardService {
* Update the card whose id you provided. <br> Scans created via this card will still be associated with the old runner. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerCard
* @returns ResponseRunnerCard
* @result ResponseRunnerCard
* @throws ApiError
*/
static async runnerCardControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class RunnerCardService {
* Delete the card whose id you provided. <br> If no card with this id exists it will just return 204(no content). <br> If the card still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with by this card - please disable it instead or just remove the runner association).
* @param id
* @param force
* @returns ResponseRunnerCard
* @returns ResponseEmpty
* @result ResponseRunnerCard
* @result ResponseEmpty
* @throws ApiError
*/
static async runnerCardControllerRemove(id, force) {
@ -85,7 +85,7 @@ class RunnerCardService {
* Create blank cards in bulk. <br> Just provide the count as a query param and wait for the 200 response. <br> You can provide the 'returnCards' query param if you want to receive the RESPONSERUNNERCARD objects in the response.
* @param count
* @param returnCards
* @returns ResponseEmpty
* @result ResponseEmpty
* @throws ApiError
*/
static async runnerCardControllerPostBlancoBulk(count, returnCards) {

14
dist/services/RunnerOrganizationService.d.ts vendored
View File

@ -7,7 +7,7 @@ export declare class RunnerOrganizationService {
/**
* Get all
* Lists all organizations. <br> This includes their address, contact and teams (if existing/associated).
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerGetAll(): Promise<Array<ResponseRunnerOrganization>>;
@ -15,7 +15,7 @@ export declare class RunnerOrganizationService {
* Post
* Create a new organsisation.
* @param requestBody CreateRunnerOrganization
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerPost(requestBody?: CreateRunnerOrganization): Promise<ResponseRunnerOrganization>;
@ -23,7 +23,7 @@ export declare class RunnerOrganizationService {
* Get one
* Lists all information about the organization whose id got provided.
* @param id
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerGetOne(id: number): Promise<ResponseRunnerOrganization>;
@ -32,7 +32,7 @@ export declare class RunnerOrganizationService {
* Update the organization whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerOrganization
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static runnerOrganizationControllerPut(id: number, requestBody?: UpdateRunnerOrganization): Promise<ResponseRunnerOrganization>;
@ -41,8 +41,8 @@ export declare class RunnerOrganizationService {
* Delete the organsisation whose id you provided. <br> If the organization still has runners and/or teams associated this will fail. <br> To delete the organization with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> This won't delete the associated contact. <br> If no organization with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunnerOrganization
* @returns ResponseEmpty
* @result ResponseRunnerOrganization
* @result ResponseEmpty
* @throws ApiError
*/
static runnerOrganizationControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerOrganization | ResponseEmpty>;
@ -51,7 +51,7 @@ export declare class RunnerOrganizationService {
* Lists all runners from this org and it's teams (if you don't provide the ?onlyDirect=true param). <br> This includes the runner's group and distance ran.
* @param id
* @param onlyDirect
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static runnerOrganizationControllerGetRunners(id: number, onlyDirect?: boolean): Promise<Array<ResponseRunner>>;

14
dist/services/RunnerOrganizationService.js vendored
View File

@ -6,7 +6,7 @@ class RunnerOrganizationService {
/**
* Get all
* Lists all organizations. <br> This includes their address, contact and teams (if existing/associated).
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganizationControllerGetAll() {
@ -20,7 +20,7 @@ class RunnerOrganizationService {
* Post
* Create a new organsisation.
* @param requestBody CreateRunnerOrganization
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganizationControllerPost(requestBody) {
@ -35,7 +35,7 @@ class RunnerOrganizationService {
* Get one
* Lists all information about the organization whose id got provided.
* @param id
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganizationControllerGetOne(id) {
@ -50,7 +50,7 @@ class RunnerOrganizationService {
* Update the organization whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerOrganization
* @returns ResponseRunnerOrganization
* @result ResponseRunnerOrganization
* @throws ApiError
*/
static async runnerOrganizationControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class RunnerOrganizationService {
* Delete the organsisation whose id you provided. <br> If the organization still has runners and/or teams associated this will fail. <br> To delete the organization with all associated runners and teams set the force QueryParam to true (cascading deletion might take a while). <br> This won't delete the associated contact. <br> If no organization with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunnerOrganization
* @returns ResponseEmpty
* @result ResponseRunnerOrganization
* @result ResponseEmpty
* @throws ApiError
*/
static async runnerOrganizationControllerRemove(id, force) {
@ -85,7 +85,7 @@ class RunnerOrganizationService {
* Lists all runners from this org and it's teams (if you don't provide the ?onlyDirect=true param). <br> This includes the runner's group and distance ran.
* @param id
* @param onlyDirect
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static async runnerOrganizationControllerGetRunners(id, onlyDirect) {

18
dist/services/RunnerSelfService.d.ts vendored
View File

@ -9,7 +9,7 @@ export declare class RunnerSelfService {
* Get
* Lists all information about yourself. <br> Please provide your runner jwt(that code we gave you during registration) for auth. <br> If you lost your jwt/personalized link please use the forgot endpoint.
* @param jwt
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static runnerSelfServiceControllerGet(jwt: string): Promise<ResponseSelfServiceRunner>;
@ -18,7 +18,7 @@ export declare class RunnerSelfService {
* Deletes all information about yourself. <br> Please provide your runner jwt(that code we gave you during registration) for auth. <br> If you lost your jwt/personalized link please use the forgot endpoint.
* @param jwt
* @param force
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static runnerSelfServiceControllerRemove(jwt: string, force?: boolean): Promise<ResponseSelfServiceRunner>;
@ -26,23 +26,23 @@ export declare class RunnerSelfService {
* Get scans
* Lists all your (runner) scans. <br> Please provide your runner jwt(that code we gave you during registration) for auth. <br> If you lost your jwt/personalized link please contact support.
* @param jwt
* @returns ResponseSelfServiceScan
* @result ResponseSelfServiceScan
* @throws ApiError
*/
static runnerSelfServiceControllerGetScans(jwt: string): Promise<Array<ResponseSelfServiceScan>>;
/**
* Get station me
* Lists basic information about the station whose token got provided. <br> This includes it's associated track.
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static runnerSelfServiceControllerGetStationMe(): Promise<ResponseScanStation>;
/**
* Request new token
* Use this endpoint to reuqest a new selfservice token/link to be sent to your mail address (rate limited to one mail every 24hrs).
* Use this endpoint to reuqest a new selfservice magic-login-link to be sent to your mail address (rate limited to one mail every 24hrs).
* @param mail
* @param locale
* @returns any Successful response
* @result any Successful response
* @throws ApiError
*/
static runnerSelfServiceControllerRequestNewToken(mail?: string, locale?: string): Promise<any>;
@ -51,7 +51,7 @@ export declare class RunnerSelfService {
* Create a new selfservice runner in the citizen org. <br> This endpoint shoud be used to allow "everyday citizen" to register themselves. <br> You have to provide a mail address, b/c the future we'll implement email verification.
* @param locale
* @param requestBody CreateSelfServiceCitizenRunner
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static runnerSelfServiceControllerRegisterRunner(locale?: string, requestBody?: CreateSelfServiceCitizenRunner): Promise<ResponseSelfServiceRunner>;
@ -61,7 +61,7 @@ export declare class RunnerSelfService {
* @param token
* @param locale
* @param requestBody CreateSelfServiceRunner
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static runnerSelfServiceControllerRegisterOrganizationRunner(token: string, locale?: string, requestBody?: CreateSelfServiceRunner): Promise<ResponseSelfServiceRunner>;
@ -69,7 +69,7 @@ export declare class RunnerSelfService {
* Get selfservice org
* Get the basic info and teams for a org.
* @param token
* @returns ResponseSelfServiceOrganisation
* @result ResponseSelfServiceOrganisation
* @throws ApiError
*/
static runnerSelfServiceControllerGetSelfserviceOrg(token: string): Promise<ResponseSelfServiceOrganisation>;

18
dist/services/RunnerSelfService.js vendored
View File

@ -7,7 +7,7 @@ class RunnerSelfService {
* Get
* Lists all information about yourself. <br> Please provide your runner jwt(that code we gave you during registration) for auth. <br> If you lost your jwt/personalized link please use the forgot endpoint.
* @param jwt
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static async runnerSelfServiceControllerGet(jwt) {
@ -22,7 +22,7 @@ class RunnerSelfService {
* Deletes all information about yourself. <br> Please provide your runner jwt(that code we gave you during registration) for auth. <br> If you lost your jwt/personalized link please use the forgot endpoint.
* @param jwt
* @param force
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static async runnerSelfServiceControllerRemove(jwt, force) {
@ -39,7 +39,7 @@ class RunnerSelfService {
* Get scans
* Lists all your (runner) scans. <br> Please provide your runner jwt(that code we gave you during registration) for auth. <br> If you lost your jwt/personalized link please contact support.
* @param jwt
* @returns ResponseSelfServiceScan
* @result ResponseSelfServiceScan
* @throws ApiError
*/
static async runnerSelfServiceControllerGetScans(jwt) {
@ -52,7 +52,7 @@ class RunnerSelfService {
/**
* Get station me
* Lists basic information about the station whose token got provided. <br> This includes it's associated track.
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static async runnerSelfServiceControllerGetStationMe() {
@ -64,10 +64,10 @@ class RunnerSelfService {
}
/**
* Request new token
* Use this endpoint to reuqest a new selfservice token/link to be sent to your mail address (rate limited to one mail every 24hrs).
* Use this endpoint to reuqest a new selfservice magic-login-link to be sent to your mail address (rate limited to one mail every 24hrs).
* @param mail
* @param locale
* @returns any Successful response
* @result any Successful response
* @throws ApiError
*/
static async runnerSelfServiceControllerRequestNewToken(mail, locale) {
@ -86,7 +86,7 @@ class RunnerSelfService {
* Create a new selfservice runner in the citizen org. <br> This endpoint shoud be used to allow "everyday citizen" to register themselves. <br> You have to provide a mail address, b/c the future we'll implement email verification.
* @param locale
* @param requestBody CreateSelfServiceCitizenRunner
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static async runnerSelfServiceControllerRegisterRunner(locale, requestBody) {
@ -106,7 +106,7 @@ class RunnerSelfService {
* @param token
* @param locale
* @param requestBody CreateSelfServiceRunner
* @returns ResponseSelfServiceRunner
* @result ResponseSelfServiceRunner
* @throws ApiError
*/
static async runnerSelfServiceControllerRegisterOrganizationRunner(token, locale, requestBody) {
@ -124,7 +124,7 @@ class RunnerSelfService {
* Get selfservice org
* Get the basic info and teams for a org.
* @param token
* @returns ResponseSelfServiceOrganisation
* @result ResponseSelfServiceOrganisation
* @throws ApiError
*/
static async runnerSelfServiceControllerGetSelfserviceOrg(token) {

14
dist/services/RunnerService.d.ts vendored
View File

@ -10,7 +10,7 @@ export declare class RunnerService {
/**
* Get all
* Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static runnerControllerGetAll(): Promise<Array<ResponseRunner>>;
@ -18,7 +18,7 @@ export declare class RunnerService {
* Post
* Create a new runner. <br> Please remeber to provide the runner's group's id.
* @param requestBody CreateRunner
* @returns any
* @result any
* @throws ApiError
*/
static runnerControllerPost(requestBody?: CreateRunner): Promise<(ResponseRunner | RunnerGroupNeededError | RunnerGroupNotFoundError)>;
@ -26,7 +26,7 @@ export declare class RunnerService {
* Get one
* Lists all information about the runner whose id got provided.
* @param id
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static runnerControllerGetOne(id: number): Promise<ResponseRunner>;
@ -35,7 +35,7 @@ export declare class RunnerService {
* Update the runner whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunner
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static runnerControllerPut(id: number, requestBody?: UpdateRunner): Promise<ResponseRunner>;
@ -44,8 +44,8 @@ export declare class RunnerService {
* Delete the runner whose id you provided. <br> This will also delete all scans and cards associated with the runner. <br> If no runner with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunner
* @returns ResponseEmpty
* @result ResponseRunner
* @result ResponseEmpty
* @throws ApiError
*/
static runnerControllerRemove(id: number, force?: boolean): Promise<ResponseRunner | ResponseEmpty>;
@ -53,7 +53,7 @@ export declare class RunnerService {
* Get scans
* Lists all scans of the runner whose id got provided. <br> If you only want the valid scans just add the ?onlyValid=true query param.
* @param id
* @returns any
* @result any
* @throws ApiError
*/
static runnerControllerGetScans(id: number): Promise<(Array<ResponseScan> | Array<ResponseTrackScan>)>;

14
dist/services/RunnerService.js vendored
View File

@ -6,7 +6,7 @@ class RunnerService {
/**
* Get all
* Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static async runnerControllerGetAll() {
@ -20,7 +20,7 @@ class RunnerService {
* Post
* Create a new runner. <br> Please remeber to provide the runner's group's id.
* @param requestBody CreateRunner
* @returns any
* @result any
* @throws ApiError
*/
static async runnerControllerPost(requestBody) {
@ -35,7 +35,7 @@ class RunnerService {
* Get one
* Lists all information about the runner whose id got provided.
* @param id
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static async runnerControllerGetOne(id) {
@ -50,7 +50,7 @@ class RunnerService {
* Update the runner whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunner
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static async runnerControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class RunnerService {
* Delete the runner whose id you provided. <br> This will also delete all scans and cards associated with the runner. <br> If no runner with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunner
* @returns ResponseEmpty
* @result ResponseRunner
* @result ResponseEmpty
* @throws ApiError
*/
static async runnerControllerRemove(id, force) {
@ -84,7 +84,7 @@ class RunnerService {
* Get scans
* Lists all scans of the runner whose id got provided. <br> If you only want the valid scans just add the ?onlyValid=true query param.
* @param id
* @returns any
* @result any
* @throws ApiError
*/
static async runnerControllerGetScans(id) {

14
dist/services/RunnerTeamService.d.ts vendored
View File

@ -7,7 +7,7 @@ export declare class RunnerTeamService {
/**
* Get all
* Lists all teams. <br> This includes their parent organization and contact (if existing/associated).
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static runnerTeamControllerGetAll(): Promise<Array<ResponseRunnerTeam>>;
@ -15,7 +15,7 @@ export declare class RunnerTeamService {
* Post
* Create a new organsisation. <br> Please remember to provide it's parent group's id.
* @param requestBody CreateRunnerTeam
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static runnerTeamControllerPost(requestBody?: CreateRunnerTeam): Promise<ResponseRunnerTeam>;
@ -23,7 +23,7 @@ export declare class RunnerTeamService {
* Get one
* Lists all information about the team whose id got provided.
* @param id
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static runnerTeamControllerGetOne(id: number): Promise<ResponseRunnerTeam>;
@ -32,7 +32,7 @@ export declare class RunnerTeamService {
* Update the team whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerTeam
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static runnerTeamControllerPut(id: number, requestBody?: UpdateRunnerTeam): Promise<ResponseRunnerTeam>;
@ -41,8 +41,8 @@ export declare class RunnerTeamService {
* 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> This won't delete the associated contact.<br> If no team with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunnerTeam
* @returns ResponseEmpty
* @result ResponseRunnerTeam
* @result ResponseEmpty
* @throws ApiError
*/
static runnerTeamControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerTeam | ResponseEmpty>;
@ -50,7 +50,7 @@ export declare class RunnerTeamService {
* Get runners
* Lists all runners from this team. <br> This includes the runner's group and distance ran.
* @param id
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static runnerTeamControllerGetRunners(id: number): Promise<Array<ResponseRunner>>;

14
dist/services/RunnerTeamService.js vendored
View File

@ -6,7 +6,7 @@ class RunnerTeamService {
/**
* Get all
* Lists all teams. <br> This includes their parent organization and contact (if existing/associated).
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerGetAll() {
@ -20,7 +20,7 @@ class RunnerTeamService {
* Post
* Create a new organsisation. <br> Please remember to provide it's parent group's id.
* @param requestBody CreateRunnerTeam
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerPost(requestBody) {
@ -35,7 +35,7 @@ class RunnerTeamService {
* Get one
* Lists all information about the team whose id got provided.
* @param id
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerGetOne(id) {
@ -50,7 +50,7 @@ class RunnerTeamService {
* Update the team whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerTeam
* @returns ResponseRunnerTeam
* @result ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class RunnerTeamService {
* 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> This won't delete the associated contact.<br> If no team with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseRunnerTeam
* @returns ResponseEmpty
* @result ResponseRunnerTeam
* @result ResponseEmpty
* @throws ApiError
*/
static async runnerTeamControllerRemove(id, force) {
@ -84,7 +84,7 @@ class RunnerTeamService {
* Get runners
* Lists all runners from this team. <br> This includes the runner's group and distance ran.
* @param id
* @returns ResponseRunner
* @result ResponseRunner
* @throws ApiError
*/
static async runnerTeamControllerGetRunners(id) {

16
dist/services/ScanService.d.ts vendored
View File

@ -9,7 +9,7 @@ export declare class ScanService {
/**
* Get all
* Lists all scans (normal or track) from all runners. <br> This includes the scan's runner's distance ran.
* @returns any
* @result any
* @throws ApiError
*/
static scanControllerGetAll(): Promise<(Array<ResponseScan> | Array<ResponseTrackScan>)>;
@ -17,7 +17,7 @@ export declare class ScanService {
* Post
* Create a new scan (not track scan - use /scans/trackscans instead). <br> Please rmemember to provide the scan's runner's id and distance.
* @param requestBody CreateScan
* @returns ResponseScan
* @result ResponseScan
* @throws ApiError
*/
static scanControllerPost(requestBody?: CreateScan): Promise<ResponseScan>;
@ -25,7 +25,7 @@ export declare class ScanService {
* Get one
* Lists all information about the scan whose id got provided. This includes the scan's runner's distance ran.
* @param id
* @returns any
* @result any
* @throws ApiError
*/
static scanControllerGetOne(id: number): Promise<(ResponseScan | ResponseTrackScan)>;
@ -34,7 +34,7 @@ export declare class ScanService {
* Update the scan (not track scan use /scans/trackscans/:id instead) whose id you provided. <br> Please remember that ids can't be changed and distances must be positive.
* @param id
* @param requestBody UpdateScan
* @returns ResponseScan
* @result ResponseScan
* @throws ApiError
*/
static scanControllerPut(id: number, requestBody?: UpdateScan): Promise<ResponseScan>;
@ -43,8 +43,8 @@ export declare class ScanService {
* Delete the scan whose id you provided. <br> If no scan with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseScan
* @returns ResponseEmpty
* @result ResponseScan
* @result ResponseEmpty
* @throws ApiError
*/
static scanControllerRemove(id: number, force?: boolean): Promise<ResponseScan | ResponseEmpty>;
@ -52,7 +52,7 @@ export declare class ScanService {
* Post track scans
* Create a new track scan (for "normal" scans use /scans instead). <br> Please remember that to provide the scan's card's station's id.
* @param requestBody CreateTrackScan
* @returns ResponseTrackScan
* @result ResponseTrackScan
* @throws ApiError
*/
static scanControllerPostTrackScans(requestBody?: CreateTrackScan): Promise<ResponseTrackScan>;
@ -61,7 +61,7 @@ export declare class ScanService {
* Update the track scan (not "normal" scan use /scans/trackscans/:id instead) whose id you provided. <br> Please remember that only the validity, runner and track can be changed.
* @param id
* @param requestBody UpdateTrackScan
* @returns ResponseTrackScan
* @result ResponseTrackScan
* @throws ApiError
*/
static scanControllerPutTrackScan(id: number, requestBody?: UpdateTrackScan): Promise<ResponseTrackScan>;

16
dist/services/ScanService.js vendored
View File

@ -6,7 +6,7 @@ class ScanService {
/**
* Get all
* Lists all scans (normal or track) from all runners. <br> This includes the scan's runner's distance ran.
* @returns any
* @result any
* @throws ApiError
*/
static async scanControllerGetAll() {
@ -20,7 +20,7 @@ class ScanService {
* Post
* Create a new scan (not track scan - use /scans/trackscans instead). <br> Please rmemember to provide the scan's runner's id and distance.
* @param requestBody CreateScan
* @returns ResponseScan
* @result ResponseScan
* @throws ApiError
*/
static async scanControllerPost(requestBody) {
@ -35,7 +35,7 @@ class ScanService {
* Get one
* Lists all information about the scan whose id got provided. This includes the scan's runner's distance ran.
* @param id
* @returns any
* @result any
* @throws ApiError
*/
static async scanControllerGetOne(id) {
@ -50,7 +50,7 @@ class ScanService {
* Update the scan (not track scan use /scans/trackscans/:id instead) whose id you provided. <br> Please remember that ids can't be changed and distances must be positive.
* @param id
* @param requestBody UpdateScan
* @returns ResponseScan
* @result ResponseScan
* @throws ApiError
*/
static async scanControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class ScanService {
* Delete the scan whose id you provided. <br> If no scan with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseScan
* @returns ResponseEmpty
* @result ResponseScan
* @result ResponseEmpty
* @throws ApiError
*/
static async scanControllerRemove(id, force) {
@ -84,7 +84,7 @@ class ScanService {
* Post track scans
* Create a new track scan (for "normal" scans use /scans instead). <br> Please remember that to provide the scan's card's station's id.
* @param requestBody CreateTrackScan
* @returns ResponseTrackScan
* @result ResponseTrackScan
* @throws ApiError
*/
static async scanControllerPostTrackScans(requestBody) {
@ -100,7 +100,7 @@ class ScanService {
* Update the track scan (not "normal" scan use /scans/trackscans/:id instead) whose id you provided. <br> Please remember that only the validity, runner and track can be changed.
* @param id
* @param requestBody UpdateTrackScan
* @returns ResponseTrackScan
* @result ResponseTrackScan
* @throws ApiError
*/
static async scanControllerPutTrackScan(id, requestBody) {

12
dist/services/ScanStationService.d.ts vendored
View File

@ -6,7 +6,7 @@ export declare class ScanStationService {
/**
* Get all
* Lists all stations. <br> This includes their associated tracks.
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static scanStationControllerGetAll(): Promise<Array<ResponseScanStation>>;
@ -14,7 +14,7 @@ export declare class ScanStationService {
* Post
* Create a new station. <br> Please remeber to provide the station's track's id. <br> Please also remember that the station key is only visibe on creation.
* @param requestBody CreateScanStation
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static scanStationControllerPost(requestBody?: CreateScanStation): Promise<ResponseScanStation>;
@ -22,7 +22,7 @@ export declare class ScanStationService {
* Get one
* Lists all information about the station whose id got provided. <br> This includes it's associated track.
* @param id
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static scanStationControllerGetOne(id: number): Promise<ResponseScanStation>;
@ -31,7 +31,7 @@ export declare class ScanStationService {
* Update the station whose id you provided. <br> Please remember that only the description and enabled state can be changed.
* @param id
* @param requestBody UpdateScanStation
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static scanStationControllerPut(id: number, requestBody?: UpdateScanStation): Promise<ResponseScanStation>;
@ -40,8 +40,8 @@ export declare class ScanStationService {
* Delete the station whose id you provided. <br> If no station with this id exists it will just return 204(no content). <br> If the station still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with/created by this station - please disable it instead).
* @param id
* @param force
* @returns ResponseScanStation
* @returns ResponseEmpty
* @result ResponseScanStation
* @result ResponseEmpty
* @throws ApiError
*/
static scanStationControllerRemove(id: number, force?: boolean): Promise<ResponseScanStation | ResponseEmpty>;

12
dist/services/ScanStationService.js vendored
View File

@ -6,7 +6,7 @@ class ScanStationService {
/**
* Get all
* Lists all stations. <br> This includes their associated tracks.
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static async scanStationControllerGetAll() {
@ -20,7 +20,7 @@ class ScanStationService {
* Post
* Create a new station. <br> Please remeber to provide the station's track's id. <br> Please also remember that the station key is only visibe on creation.
* @param requestBody CreateScanStation
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static async scanStationControllerPost(requestBody) {
@ -35,7 +35,7 @@ class ScanStationService {
* Get one
* Lists all information about the station whose id got provided. <br> This includes it's associated track.
* @param id
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static async scanStationControllerGetOne(id) {
@ -50,7 +50,7 @@ class ScanStationService {
* Update the station whose id you provided. <br> Please remember that only the description and enabled state can be changed.
* @param id
* @param requestBody UpdateScanStation
* @returns ResponseScanStation
* @result ResponseScanStation
* @throws ApiError
*/
static async scanStationControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class ScanStationService {
* Delete the station whose id you provided. <br> If no station with this id exists it will just return 204(no content). <br> If the station still has scans associated you have to provide the force=true query param (warning: this deletes all scans associated with/created by this station - please disable it instead).
* @param id
* @param force
* @returns ResponseScanStation
* @returns ResponseEmpty
* @result ResponseScanStation
* @result ResponseEmpty
* @throws ApiError
*/
static async scanStationControllerRemove(id, force) {

10
dist/services/StatsClientService.d.ts vendored
View File

@ -5,7 +5,7 @@ export declare class StatsClientService {
/**
* Get all
* Lists all stats clients. Please remember that the key can only be viewed on creation.
* @returns ResponseStatsClient
* @result ResponseStatsClient
* @throws ApiError
*/
static statsClientControllerGetAll(): Promise<Array<ResponseStatsClient>>;
@ -13,7 +13,7 @@ export declare class StatsClientService {
* Post
* Create a new stats client. <br> Please remember that the client's key will be generated automaticly and that it can only be viewed on creation.
* @param requestBody CreateStatsClient
* @returns ResponseStatsClient
* @result ResponseStatsClient
* @throws ApiError
*/
static statsClientControllerPost(requestBody?: CreateStatsClient): Promise<ResponseStatsClient>;
@ -21,7 +21,7 @@ export declare class StatsClientService {
* Get one
* Lists all information about the stats client whose id got provided. Please remember that the key can only be viewed on creation.
* @param id
* @returns ResponseStatsClient
* @result ResponseStatsClient
* @throws ApiError
*/
static statsClientControllerGetOne(id: number): Promise<ResponseStatsClient>;
@ -30,8 +30,8 @@ export declare class StatsClientService {
* Delete the stats client whose id you provided. <br> If no client with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseStatsClient
* @returns ResponseEmpty
* @result ResponseStatsClient
* @result ResponseEmpty
* @throws ApiError
*/
static statsClientControllerRemove(id: number, force?: boolean): Promise<ResponseStatsClient | ResponseEmpty>;

10
dist/services/StatsClientService.js vendored
View File

@ -6,7 +6,7 @@ class StatsClientService {
/**
* Get all
* Lists all stats clients. Please remember that the key can only be viewed on creation.
* @returns ResponseStatsClient
* @result ResponseStatsClient
* @throws ApiError
*/
static async statsClientControllerGetAll() {
@ -20,7 +20,7 @@ class StatsClientService {
* Post
* Create a new stats client. <br> Please remember that the client's key will be generated automaticly and that it can only be viewed on creation.
* @param requestBody CreateStatsClient
* @returns ResponseStatsClient
* @result ResponseStatsClient
* @throws ApiError
*/
static async statsClientControllerPost(requestBody) {
@ -35,7 +35,7 @@ class StatsClientService {
* Get one
* Lists all information about the stats client whose id got provided. Please remember that the key can only be viewed on creation.
* @param id
* @returns ResponseStatsClient
* @result ResponseStatsClient
* @throws ApiError
*/
static async statsClientControllerGetOne(id) {
@ -50,8 +50,8 @@ class StatsClientService {
* Delete the stats client whose id you provided. <br> If no client with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseStatsClient
* @returns ResponseEmpty
* @result ResponseStatsClient
* @result ResponseEmpty
* @throws ApiError
*/
static async statsClientControllerRemove(id, force) {

18
dist/services/StatsService.d.ts vendored
View File

@ -6,21 +6,21 @@ export declare class StatsService {
/**
* Get
* A very basic stats endpoint providing basic counters for a dashboard or simmilar
* @returns ResponseStats
* @result ResponseStats
* @throws ApiError
*/
static statsControllerGet(): Promise<ResponseStats>;
/**
* Get top runners by distance
* Returns the top ten runners by distance.
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByDistance(): Promise<Array<ResponseStatsRunner>>;
/**
* Get top runners by donations
* Returns the top ten runners by donations.
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByDonations(): Promise<Array<ResponseStatsRunner>>;
@ -28,42 +28,42 @@ export declare class StatsService {
* Get top runners by laptime
* Returns the top ten runners by fastest laptime on your selected track (track by id).
* @param track
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByLaptime(track?: number): Promise<Array<ResponseStatsRunner>>;
/**
* Get top runners by track time
* Returns the top ten fastest track times (with their runner and the runner's group).
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByTrackTime(): Promise<Array<ResponseStatsRunner>>;
/**
* Get top teams by distance
* Returns the top ten teams by distance.
* @returns ResponseStatsTeam
* @result ResponseStatsTeam
* @throws ApiError
*/
static statsControllerGetTopTeamsByDistance(): Promise<Array<ResponseStatsTeam>>;
/**
* Get top teams by donations
* Returns the top ten teams by donations.
* @returns ResponseStatsTeam
* @result ResponseStatsTeam
* @throws ApiError
*/
static statsControllerGetTopTeamsByDonations(): Promise<Array<ResponseStatsTeam>>;
/**
* Get top orgs by distance
* Returns the top ten organizations by distance.
* @returns ResponseStatsOrgnisation
* @result ResponseStatsOrgnisation
* @throws ApiError
*/
static statsControllerGetTopOrgsByDistance(): Promise<Array<ResponseStatsOrgnisation>>;
/**
* Get top orgs by donations
* Returns the top ten organizations by donations.
* @returns ResponseStatsOrgnisation
* @result ResponseStatsOrgnisation
* @throws ApiError
*/
static statsControllerGetTopOrgsByDonations(): Promise<Array<ResponseStatsOrgnisation>>;

18
dist/services/StatsService.js vendored
View File

@ -6,7 +6,7 @@ class StatsService {
/**
* Get
* A very basic stats endpoint providing basic counters for a dashboard or simmilar
* @returns ResponseStats
* @result ResponseStats
* @throws ApiError
*/
static async statsControllerGet() {
@ -19,7 +19,7 @@ class StatsService {
/**
* Get top runners by distance
* Returns the top ten runners by distance.
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static async statsControllerGetTopRunnersByDistance() {
@ -32,7 +32,7 @@ class StatsService {
/**
* Get top runners by donations
* Returns the top ten runners by donations.
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static async statsControllerGetTopRunnersByDonations() {
@ -46,7 +46,7 @@ class StatsService {
* Get top runners by laptime
* Returns the top ten runners by fastest laptime on your selected track (track by id).
* @param track
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static async statsControllerGetTopRunnersByLaptime(track) {
@ -62,7 +62,7 @@ class StatsService {
/**
* Get top runners by track time
* Returns the top ten fastest track times (with their runner and the runner's group).
* @returns ResponseStatsRunner
* @result ResponseStatsRunner
* @throws ApiError
*/
static async statsControllerGetTopRunnersByTrackTime() {
@ -75,7 +75,7 @@ class StatsService {
/**
* Get top teams by distance
* Returns the top ten teams by distance.
* @returns ResponseStatsTeam
* @result ResponseStatsTeam
* @throws ApiError
*/
static async statsControllerGetTopTeamsByDistance() {
@ -88,7 +88,7 @@ class StatsService {
/**
* Get top teams by donations
* Returns the top ten teams by donations.
* @returns ResponseStatsTeam
* @result ResponseStatsTeam
* @throws ApiError
*/
static async statsControllerGetTopTeamsByDonations() {
@ -101,7 +101,7 @@ class StatsService {
/**
* Get top orgs by distance
* Returns the top ten organizations by distance.
* @returns ResponseStatsOrgnisation
* @result ResponseStatsOrgnisation
* @throws ApiError
*/
static async statsControllerGetTopOrgsByDistance() {
@ -114,7 +114,7 @@ class StatsService {
/**
* Get top orgs by donations
* Returns the top ten organizations by donations.
* @returns ResponseStatsOrgnisation
* @result ResponseStatsOrgnisation
* @throws ApiError
*/
static async statsControllerGetTopOrgsByDonations() {

4
dist/services/StatusService.d.ts vendored
View File

@ -2,14 +2,14 @@ export declare class StatusService {
/**
* Get
* 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
* @result any Successful response
* @throws ApiError
*/
static statusControllerGet(): Promise<any>;
/**
* Get version
* A very basic endpoint that just returns the curent package version.
* @returns any Successful response
* @result any Successful response
* @throws ApiError
*/
static statusControllerGetVersion(): Promise<any>;

4
dist/services/StatusService.js vendored
View File

@ -9,7 +9,7 @@ class StatusService {
/**
* Get
* 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
* @result any Successful response
* @throws ApiError
*/
static async statusControllerGet() {
@ -22,7 +22,7 @@ class StatusService {
/**
* Get version
* A very basic endpoint that just returns the curent package version.
* @returns any Successful response
* @result any Successful response
* @throws ApiError
*/
static async statusControllerGetVersion() {

12
dist/services/TrackService.d.ts vendored
View File

@ -6,7 +6,7 @@ export declare class TrackService {
/**
* Get all
* Lists all tracks.
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static trackControllerGetAll(): Promise<Array<ResponseTrack>>;
@ -14,7 +14,7 @@ export declare class TrackService {
* Post
* Create a new track. <br> Please remember that the track's distance must be greater than 0.
* @param requestBody CreateTrack
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static trackControllerPost(requestBody?: CreateTrack): Promise<ResponseTrack>;
@ -22,7 +22,7 @@ export declare class TrackService {
* Get one
* Lists all information about the track whose id got provided.
* @param id
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static trackControllerGetOne(id: number): Promise<ResponseTrack>;
@ -31,7 +31,7 @@ export declare class TrackService {
* Update the track whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateTrack
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static trackControllerPut(id: number, requestBody?: UpdateTrack): Promise<ResponseTrack>;
@ -40,8 +40,8 @@ export declare class TrackService {
* Delete the track whose id you provided. <br> If no track with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseTrack
* @returns ResponseEmpty
* @result ResponseTrack
* @result ResponseEmpty
* @throws ApiError
*/
static trackControllerRemove(id: number, force?: boolean): Promise<ResponseTrack | ResponseEmpty>;

12
dist/services/TrackService.js vendored
View File

@ -6,7 +6,7 @@ class TrackService {
/**
* Get all
* Lists all tracks.
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static async trackControllerGetAll() {
@ -20,7 +20,7 @@ class TrackService {
* Post
* Create a new track. <br> Please remember that the track's distance must be greater than 0.
* @param requestBody CreateTrack
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static async trackControllerPost(requestBody) {
@ -35,7 +35,7 @@ class TrackService {
* Get one
* Lists all information about the track whose id got provided.
* @param id
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static async trackControllerGetOne(id) {
@ -50,7 +50,7 @@ class TrackService {
* Update the track whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateTrack
* @returns ResponseTrack
* @result ResponseTrack
* @throws ApiError
*/
static async trackControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class TrackService {
* Delete the track whose id you provided. <br> If no track with this id exists it will just return 204(no content).
* @param id
* @param force
* @returns ResponseTrack
* @returns ResponseEmpty
* @result ResponseTrack
* @result ResponseEmpty
* @throws ApiError
*/
static async trackControllerRemove(id, force) {

14
dist/services/UserGroupService.d.ts vendored
View File

@ -9,7 +9,7 @@ export declare class UserGroupService {
/**
* Get all
* Lists all groups. <br> The information provided might change while the project continues to evolve.
* @returns ResponseUserGroup
* @result ResponseUserGroup
* @throws ApiError
*/
static userGroupControllerGetAll(): Promise<Array<ResponseUserGroup>>;
@ -17,7 +17,7 @@ export declare class UserGroupService {
* Post
* 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
* @result any
* @throws ApiError
*/
static userGroupControllerPost(requestBody?: CreateUserGroup): Promise<(UserGroup | UserGroupNotFoundError)>;
@ -25,7 +25,7 @@ export declare class UserGroupService {
* Get one
* 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 ResponseUserGroup
* @result ResponseUserGroup
* @throws ApiError
*/
static userGroupControllerGetOne(id: number): Promise<ResponseUserGroup>;
@ -34,7 +34,7 @@ export declare class UserGroupService {
* 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 UpdateUserGroup
* @returns UserGroup
* @result UserGroup
* @throws ApiError
*/
static userGroupControllerPut(id: number, requestBody?: UpdateUserGroup): Promise<UserGroup>;
@ -43,8 +43,8 @@ export declare class UserGroupService {
* 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
* @returns ResponseEmpty
* @result ResponseUserGroup
* @result ResponseEmpty
* @throws ApiError
*/
static userGroupControllerRemove(id: number, force?: boolean): Promise<ResponseUserGroup | ResponseEmpty>;
@ -52,7 +52,7 @@ export declare class UserGroupService {
* Get permissions
* Lists all permissions granted to the group as permission response objects.
* @param id
* @returns ResponseUserGroupPermissions
* @result ResponseUserGroupPermissions
* @throws ApiError
*/
static userGroupControllerGetPermissions(id: number): Promise<ResponseUserGroupPermissions>;

14
dist/services/UserGroupService.js vendored
View File

@ -6,7 +6,7 @@ class UserGroupService {
/**
* Get all
* Lists all groups. <br> The information provided might change while the project continues to evolve.
* @returns ResponseUserGroup
* @result ResponseUserGroup
* @throws ApiError
*/
static async userGroupControllerGetAll() {
@ -20,7 +20,7 @@ class UserGroupService {
* Post
* 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
* @result any
* @throws ApiError
*/
static async userGroupControllerPost(requestBody) {
@ -35,7 +35,7 @@ class UserGroupService {
* Get one
* 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 ResponseUserGroup
* @result ResponseUserGroup
* @throws ApiError
*/
static async userGroupControllerGetOne(id) {
@ -50,7 +50,7 @@ class UserGroupService {
* 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 UpdateUserGroup
* @returns UserGroup
* @result UserGroup
* @throws ApiError
*/
static async userGroupControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class UserGroupService {
* 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
* @returns ResponseEmpty
* @result ResponseUserGroup
* @result ResponseEmpty
* @throws ApiError
*/
static async userGroupControllerRemove(id, force) {
@ -84,7 +84,7 @@ class UserGroupService {
* Get permissions
* Lists all permissions granted to the group as permission response objects.
* @param id
* @returns ResponseUserGroupPermissions
* @result ResponseUserGroupPermissions
* @throws ApiError
*/
static async userGroupControllerGetPermissions(id) {

14
dist/services/UserService.d.ts vendored
View File

@ -6,7 +6,7 @@ export declare class UserService {
/**
* Get all
* Lists all users. <br> This includes their groups and permissions granted to them.
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static userControllerGetAll(): Promise<Array<ResponseUser>>;
@ -14,7 +14,7 @@ export declare class UserService {
* Post
* 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 ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static userControllerPost(requestBody?: CreateUser): Promise<ResponseUser>;
@ -22,7 +22,7 @@ export declare class UserService {
* Get one
* Lists all information about the user whose id got provided. <br> Please remember that all permissions granted to the user will show up here.
* @param id
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static userControllerGetOne(id: number): Promise<ResponseUser>;
@ -31,7 +31,7 @@ export declare class UserService {
* 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 ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static userControllerPut(id: number, requestBody?: UpdateUser): Promise<ResponseUser>;
@ -40,8 +40,8 @@ export declare class UserService {
* Delete the user whose id you provided. <br> You have to confirm your decision by providing the ?force=true query param. <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 ResponseUser
* @returns ResponseEmpty
* @result ResponseUser
* @result ResponseEmpty
* @throws ApiError
*/
static userControllerRemove(id: number, force?: boolean): Promise<ResponseUser | ResponseEmpty>;
@ -49,7 +49,7 @@ export declare class UserService {
* Get permissions
* Lists all permissions granted to the user sorted into directly granted and inherited as permission response objects.
* @param id
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static userControllerGetPermissions(id: number): Promise<ResponseUser>;

14
dist/services/UserService.js vendored
View File

@ -6,7 +6,7 @@ class UserService {
/**
* Get all
* Lists all users. <br> This includes their groups and permissions granted to them.
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async userControllerGetAll() {
@ -20,7 +20,7 @@ class UserService {
* Post
* 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 ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async userControllerPost(requestBody) {
@ -35,7 +35,7 @@ class UserService {
* Get one
* Lists all information about the user whose id got provided. <br> Please remember that all permissions granted to the user will show up here.
* @param id
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async userControllerGetOne(id) {
@ -50,7 +50,7 @@ class UserService {
* 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 ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async userControllerPut(id, requestBody) {
@ -66,8 +66,8 @@ class UserService {
* Delete the user whose id you provided. <br> You have to confirm your decision by providing the ?force=true query param. <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 ResponseUser
* @returns ResponseEmpty
* @result ResponseUser
* @result ResponseEmpty
* @throws ApiError
*/
static async userControllerRemove(id, force) {
@ -84,7 +84,7 @@ class UserService {
* Get permissions
* Lists all permissions granted to the user sorted into directly granted and inherited as permission response objects.
* @param id
* @returns ResponseUser
* @result ResponseUser
* @throws ApiError
*/
static async userControllerGetPermissions(id) {

2
openapi.json
View File

File diff suppressed because one or more lines are too long

2
package.json
View File

@ -1,7 +1,7 @@
{
"name": "@odit/lfk-client-js",
"description": "A lib to interact with https://git.odit.services/lfk/backend. Use this version for native JS applications.",
"version": "0.13.0",
"version": "0.13.1",
"license": "CC-BY-NC-SA-4.0",
"main": "./dist/index.js",
"types": "./dist/index.d.ts",