lfk/lfk-client-node
Archived
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

new lib version [CI SKIP]
All checks were successful
continuous-integration/drone Build is passing
Details

Browse Source
This commit is contained in:
Nicolai Ort
2021-01-03 17:33:57 +00:00
parent 75fa469974
commit 46e9ee2a1b
192 changed files with 6 additions and 2614 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,61 +0,0 @@
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';
import type { JwtNotProvidedError } from '../models/JwtNotProvidedError';
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
* 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
*/
static authControllerLogin(requestBody?: CreateAuth): Promise<(Auth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
/**
* Logout
* Logout using your refresh token. <br> This instantly invalidates all your access and refresh tokens.
* @param requestBody HandleLogout
* @returns any
* @throws ApiError
*/
static authControllerLogout(requestBody?: HandleLogout): Promise<(Logout | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
/**
* 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)
* @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)>;
}

87
dist/services/AuthService.js vendored
View File

@@ -1,87 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.AuthService = void 0;
const request_1 = require("../core/request");
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)
* @param requestBody CreateAuth
* @returns any
* @throws ApiError
*/
static async authControllerLogin(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/auth/login`,
body: requestBody,
});
return result.body;
}
/**
* Logout
* Logout using your refresh token. <br> This instantly invalidates all your access and refresh tokens.
* @param requestBody HandleLogout
* @returns any
* @throws ApiError
*/
static async authControllerLogout(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/auth/logout`,
body: requestBody,
});
return result.body;
}
/**
* 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)
* @param requestBody RefreshAuth
* @returns any
* @throws ApiError
*/
static async authControllerRefresh(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/auth/refresh`,
body: requestBody,
});
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;

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

@@ -1,55 +0,0 @@
import type { ImportRunner } from '../models/ImportRunner';
import type { ResponseRunner } from '../models/ResponseRunner';
export declare class ImportService {
/**
* Post json
* 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
* @throws ApiError
*/
static importControllerPostJson(group?: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
/**
* Post orgs json
* 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
* @throws ApiError
*/
static importControllerPostOrgsJson(id: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
/**
* Post teams json
* Create new runners from json and insert them into the provided team
* @param id
* @param requestBody ImportRunner
* @returns ResponseRunner
* @throws ApiError
*/
static importControllerPostTeamsJson(id: number, requestBody?: Array<ImportRunner>): Promise<Array<ResponseRunner>>;
/**
* 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
* @throws ApiError
*/
static importControllerPostCsv(group?: number): Promise<Array<ResponseRunner>>;
/**
* 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
* @throws ApiError
*/
static importControllerPostOrgsCsv(id: number): Promise<Array<ResponseRunner>>;
/**
* Post teams csv
* Create new runners from csv and insert them into the provided team
* @param id
* @returns ResponseRunner
* @throws ApiError
*/
static importControllerPostTeamsCsv(id: number): Promise<Array<ResponseRunner>>;
}

103
dist/services/ImportService.js vendored
View File

@@ -1,103 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ImportService = void 0;
const request_1 = require("../core/request");
class ImportService {
/**
* Post json
* 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
* @throws ApiError
*/
static async importControllerPostJson(group, requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/runners/import`,
query: {
'group': group,
},
body: requestBody,
});
return result.body;
}
/**
* Post orgs json
* 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
* @throws ApiError
*/
static async importControllerPostOrgsJson(id, requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/organisations/${id}/import`,
body: requestBody,
});
return result.body;
}
/**
* Post teams json
* Create new runners from json and insert them into the provided team
* @param id
* @param requestBody ImportRunner
* @returns ResponseRunner
* @throws ApiError
*/
static async importControllerPostTeamsJson(id, requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/teams/${id}/import`,
body: requestBody,
});
return result.body;
}
/**
* 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
* @throws ApiError
*/
static async importControllerPostCsv(group) {
const result = await request_1.request({
method: 'POST',
path: `/api/runners/import/csv`,
query: {
'group': group,
},
});
return result.body;
}
/**
* 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
* @throws ApiError
*/
static async importControllerPostOrgsCsv(id) {
const result = await request_1.request({
method: 'POST',
path: `/api/organisations/${id}/import/csv`,
});
return result.body;
}
/**
* Post teams csv
* Create new runners from csv and insert them into the provided team
* @param id
* @returns ResponseRunner
* @throws ApiError
*/
static async importControllerPostTeamsCsv(id) {
const result = await request_1.request({
method: 'POST',
path: `/api/teams/${id}/import/csv`,
});
return result.body;
}
}
exports.ImportService = ImportService;

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

@@ -1,49 +0,0 @@
import type { CreatePermission } from '../models/CreatePermission';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponsePermission } from '../models/ResponsePermission';
import type { ResponsePrincipal } from '../models/ResponsePrincipal';
import type { UpdatePermission } from '../models/UpdatePermission';
export declare class PermissionService {
/**
* Get all
* Lists all permissions for all users and groups.
* @returns ResponsePermission
* @throws ApiError
*/
static permissionControllerGetAll(): Promise<Array<ResponsePermission>>;
/**
* 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
* @throws ApiError
*/
static permissionControllerPost(requestBody?: CreatePermission): Promise<ResponsePermission>;
/**
* Get one
* Lists all information about the permission whose id got provided.
* @param id
* @returns ResponsePermission
* @throws ApiError
*/
static permissionControllerGetOne(id: number): Promise<ResponsePermission>;
/**
* Put
* 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
* @throws ApiError
*/
static permissionControllerPut(id: number, requestBody?: UpdatePermission): Promise<ResponsePrincipal>;
/**
* Remove
* 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
* @throws ApiError
*/
static permissionControllerRemove(id: number, force?: boolean): Promise<ResponsePermission | ResponseEmpty>;
}

84
dist/services/PermissionService.js vendored
View File

@@ -1,84 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.PermissionService = void 0;
const request_1 = require("../core/request");
class PermissionService {
/**
* Get all
* Lists all permissions for all users and groups.
* @returns ResponsePermission
* @throws ApiError
*/
static async permissionControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/permissions`,
});
return result.body;
}
/**
* 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
* @throws ApiError
*/
static async permissionControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/permissions`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the permission whose id got provided.
* @param id
* @returns ResponsePermission
* @throws ApiError
*/
static async permissionControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/permissions/${id}`,
});
return result.body;
}
/**
* Put
* 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
* @throws ApiError
*/
static async permissionControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/permissions/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @throws ApiError
*/
static async permissionControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/permissions/${id}`,
query: {
'force': force,
},
});
return result.body;
}
}
exports.PermissionService = PermissionService;

48
dist/services/RunnerOrganisationService.d.ts vendored
View File

@@ -1,48 +0,0 @@
import type { CreateRunnerOrganisation } from '../models/CreateRunnerOrganisation';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseRunnerOrganisation } from '../models/ResponseRunnerOrganisation';
import type { UpdateRunnerOrganisation } from '../models/UpdateRunnerOrganisation';
export declare class RunnerOrganisationService {
/**
* Get all
* 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 organsisation.
* @param requestBody CreateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static runnerOrganisationControllerPost(requestBody?: CreateRunnerOrganisation): Promise<ResponseRunnerOrganisation>;
/**
* Get one
* Lists all information about the organisation whose id got provided.
* @param id
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static runnerOrganisationControllerGetOne(id: number): Promise<ResponseRunnerOrganisation>;
/**
* Put
* Update the organisation whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static runnerOrganisationControllerPut(id: number, requestBody?: UpdateRunnerOrganisation): Promise<ResponseRunnerOrganisation>;
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static runnerOrganisationControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerOrganisation | ResponseEmpty>;
}

84
dist/services/RunnerOrganisationService.js vendored
View File

@@ -1,84 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RunnerOrganisationService = void 0;
const request_1 = require("../core/request");
class RunnerOrganisationService {
/**
* Get all
* Lists all organisations. <br> This includes their address, contact and teams (if existing/associated).
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static async runnerOrganisationControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/organisations`,
});
return result.body;
}
/**
* Post
* Create a new organsisation.
* @param requestBody CreateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static async runnerOrganisationControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/organisations`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the organisation whose id got provided.
* @param id
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static async runnerOrganisationControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/organisations/${id}`,
});
return result.body;
}
/**
* Put
* Update the organisation whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerOrganisation
* @returns ResponseRunnerOrganisation
* @throws ApiError
*/
static async runnerOrganisationControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/organisations/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static async runnerOrganisationControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/organisations/${id}`,
query: {
'force': force,
},
});
return result.body;
}
}
exports.RunnerOrganisationService = RunnerOrganisationService;

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

@@ -1,50 +0,0 @@
import type { CreateRunner } from '../models/CreateRunner';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseRunner } from '../models/ResponseRunner';
import type { RunnerGroupNeededError } from '../models/RunnerGroupNeededError';
import type { RunnerGroupNotFoundError } from '../models/RunnerGroupNotFoundError';
import type { UpdateRunner } from '../models/UpdateRunner';
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
* @throws ApiError
*/
static runnerControllerGetAll(): Promise<Array<ResponseRunner>>;
/**
* Post
* Create a new runner. <br> Please remeber to provide the runner's group's id.
* @param requestBody CreateRunner
* @returns any
* @throws ApiError
*/
static runnerControllerPost(requestBody?: CreateRunner): Promise<(ResponseRunner | RunnerGroupNeededError | RunnerGroupNotFoundError)>;
/**
* Get one
* Lists all information about the runner whose id got provided.
* @param id
* @returns ResponseRunner
* @throws ApiError
*/
static runnerControllerGetOne(id: number): Promise<ResponseRunner>;
/**
* Put
* Update the runner whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunner
* @returns ResponseRunner
* @throws ApiError
*/
static runnerControllerPut(id: number, requestBody?: UpdateRunner): Promise<ResponseRunner>;
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static runnerControllerRemove(id: number, force?: boolean): Promise<ResponseRunner | ResponseEmpty>;
}

84
dist/services/RunnerService.js vendored
View File

@@ -1,84 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RunnerService = void 0;
const request_1 = require("../core/request");
class RunnerService {
/**
* Get all
* Lists all runners from all teams/orgs. <br> This includes the runner's group and distance ran.
* @returns ResponseRunner
* @throws ApiError
*/
static async runnerControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/runners`,
});
return result.body;
}
/**
* Post
* Create a new runner. <br> Please remeber to provide the runner's group's id.
* @param requestBody CreateRunner
* @returns any
* @throws ApiError
*/
static async runnerControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/runners`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the runner whose id got provided.
* @param id
* @returns ResponseRunner
* @throws ApiError
*/
static async runnerControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/runners/${id}`,
});
return result.body;
}
/**
* Put
* Update the runner whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunner
* @returns ResponseRunner
* @throws ApiError
*/
static async runnerControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/runners/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static async runnerControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/runners/${id}`,
query: {
'force': force,
},
});
return result.body;
}
}
exports.RunnerService = RunnerService;

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

@@ -1,48 +0,0 @@
import type { CreateRunnerTeam } from '../models/CreateRunnerTeam';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseRunnerTeam } from '../models/ResponseRunnerTeam';
import type { UpdateRunnerTeam } from '../models/UpdateRunnerTeam';
export declare class RunnerTeamService {
/**
* Get all
* 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 organsisation. <br> Please remember to provide it's parent group's id.
* @param requestBody CreateRunnerTeam
* @returns ResponseRunnerTeam
* @throws ApiError
*/
static runnerTeamControllerPost(requestBody?: CreateRunnerTeam): Promise<ResponseRunnerTeam>;
/**
* Get one
* Lists all information about the team whose id got provided.
* @param id
* @returns ResponseRunnerTeam
* @throws ApiError
*/
static runnerTeamControllerGetOne(id: number): Promise<ResponseRunnerTeam>;
/**
* Put
* Update the team whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerTeam
* @returns ResponseRunnerTeam
* @throws ApiError
*/
static runnerTeamControllerPut(id: number, requestBody?: UpdateRunnerTeam): Promise<ResponseRunnerTeam>;
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static runnerTeamControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerTeam | ResponseEmpty>;
}

84
dist/services/RunnerTeamService.js vendored
View File

@@ -1,84 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RunnerTeamService = void 0;
const request_1 = require("../core/request");
class RunnerTeamService {
/**
* Get all
* Lists all teams. <br> This includes their parent organisation and contact (if existing/associated).
* @returns ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/teams`,
});
return result.body;
}
/**
* Post
* Create a new organsisation. <br> Please remember to provide it's parent group's id.
* @param requestBody CreateRunnerTeam
* @returns ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/teams`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the team whose id got provided.
* @param id
* @returns ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/teams/${id}`,
});
return result.body;
}
/**
* Put
* Update the team whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody UpdateRunnerTeam
* @returns ResponseRunnerTeam
* @throws ApiError
*/
static async runnerTeamControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/teams/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static async runnerTeamControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/teams/${id}`,
query: {
'force': force,
},
});
return result.body;
}
}
exports.RunnerTeamService = RunnerTeamService;

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

@@ -1,37 +0,0 @@
import type { CreateStatsClient } from '../models/CreateStatsClient';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseStatsClient } from '../models/ResponseStatsClient';
export declare class StatsClientService {
/**
* Get all
* Lists all stats clients. Please remember that the key can only be viewed on creation.
* @returns ResponseStatsClient
* @throws ApiError
*/
static statsClientControllerGetAll(): Promise<Array<ResponseStatsClient>>;
/**
* 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
* @throws ApiError
*/
static statsClientControllerPost(requestBody?: CreateStatsClient): Promise<ResponseStatsClient>;
/**
* 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
* @throws ApiError
*/
static statsClientControllerGetOne(id: number): Promise<ResponseStatsClient>;
/**
* Remove
* 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
* @returns ResponseStatsClient
* @returns ResponseEmpty
* @throws ApiError
*/
static statsClientControllerRemove(id: number): Promise<ResponseStatsClient | ResponseEmpty>;
}

64
dist/services/StatsClientService.js vendored
View File

@@ -1,64 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.StatsClientService = void 0;
const request_1 = require("../core/request");
class StatsClientService {
/**
* Get all
* Lists all stats clients. Please remember that the key can only be viewed on creation.
* @returns ResponseStatsClient
* @throws ApiError
*/
static async statsClientControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/statsclients`,
});
return result.body;
}
/**
* 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
* @throws ApiError
*/
static async statsClientControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/statsclients`,
body: requestBody,
});
return result.body;
}
/**
* 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
* @throws ApiError
*/
static async statsClientControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/statsclients/${id}`,
});
return result.body;
}
/**
* Remove
* 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
* @returns ResponseStatsClient
* @returns ResponseEmpty
* @throws ApiError
*/
static async statsClientControllerRemove(id) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/statsclients/${id}`,
});
return result.body;
}
}
exports.StatsClientService = StatsClientService;

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

@@ -1,62 +0,0 @@
import type { ResponseStats } from '../models/ResponseStats';
import type { ResponseStatsOrgnisation } from '../models/ResponseStatsOrgnisation';
import type { ResponseStatsRunner } from '../models/ResponseStatsRunner';
import type { ResponseStatsTeam } from '../models/ResponseStatsTeam';
export declare class StatsService {
/**
* Get
* A very basic stats endpoint providing basic counters for a dashboard or simmilar
* @returns ResponseStats
* @throws ApiError
*/
static statsControllerGet(): Promise<ResponseStats>;
/**
* Get top runners by distance
* Returns the top ten runners by distance.
* @returns ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByDistance(): Promise<Array<ResponseStatsRunner>>;
/**
* Get top runners by donations
* Returns the top ten runners by donations.
* @returns ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByDonations(): 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
* @throws ApiError
*/
static statsControllerGetTopRunnersByTrackTime(): Promise<Array<ResponseStatsRunner>>;
/**
* Get top teams by distance
* Returns the top ten teams by distance.
* @returns ResponseStatsTeam
* @throws ApiError
*/
static statsControllerGetTopTeamsByDistance(): Promise<Array<ResponseStatsTeam>>;
/**
* Get top teams by donations
* Returns the top ten teams by donations.
* @returns ResponseStatsTeam
* @throws ApiError
*/
static statsControllerGetTopTeamsByDonations(): Promise<Array<ResponseStatsTeam>>;
/**
* Get top orgs by distance
* Returns the top ten organisations by distance.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static statsControllerGetTopOrgsByDistance(): Promise<Array<ResponseStatsOrgnisation>>;
/**
* Get top orgs by donations
* Returns the top ten organisations by donations.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static statsControllerGetTopOrgsByDonations(): Promise<Array<ResponseStatsOrgnisation>>;
}

111
dist/services/StatsService.js vendored
View File

@@ -1,111 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.StatsService = void 0;
const request_1 = require("../core/request");
class StatsService {
/**
* Get
* A very basic stats endpoint providing basic counters for a dashboard or simmilar
* @returns ResponseStats
* @throws ApiError
*/
static async statsControllerGet() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats`,
});
return result.body;
}
/**
* Get top runners by distance
* Returns the top ten runners by distance.
* @returns ResponseStatsRunner
* @throws ApiError
*/
static async statsControllerGetTopRunnersByDistance() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/runners/distance`,
});
return result.body;
}
/**
* Get top runners by donations
* Returns the top ten runners by donations.
* @returns ResponseStatsRunner
* @throws ApiError
*/
static async statsControllerGetTopRunnersByDonations() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/runners/donations`,
});
return result.body;
}
/**
* Get top runners by track time
* Returns the top ten fastest track times (with their runner and the runner's group).
* @returns ResponseStatsRunner
* @throws ApiError
*/
static async statsControllerGetTopRunnersByTrackTime() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/scans`,
});
return result.body;
}
/**
* Get top teams by distance
* Returns the top ten teams by distance.
* @returns ResponseStatsTeam
* @throws ApiError
*/
static async statsControllerGetTopTeamsByDistance() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/teams/distance`,
});
return result.body;
}
/**
* Get top teams by donations
* Returns the top ten teams by donations.
* @returns ResponseStatsTeam
* @throws ApiError
*/
static async statsControllerGetTopTeamsByDonations() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/teams/donations`,
});
return result.body;
}
/**
* Get top orgs by distance
* Returns the top ten organisations by distance.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static async statsControllerGetTopOrgsByDistance() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/organisations/distance`,
});
return result.body;
}
/**
* Get top orgs by donations
* Returns the top ten organisations by donations.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static async statsControllerGetTopOrgsByDonations() {
const result = await request_1.request({
method: 'GET',
path: `/api/stats/organisations/donations`,
});
return result.body;
}
}
exports.StatsService = StatsService;

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

@@ -1,9 +0,0 @@
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
* @throws ApiError
*/
static statusControllerGet(): Promise<any>;
}

23
dist/services/StatusService.js vendored
View File

@@ -1,23 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.StatusService = void 0;
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
const request_1 = require("../core/request");
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
* @throws ApiError
*/
static async statusControllerGet() {
const result = await request_1.request({
method: 'GET',
path: `/api/status`,
});
return result.body;
}
}
exports.StatusService = StatusService;

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

@@ -1,47 +0,0 @@
import type { CreateTrack } from '../models/CreateTrack';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseTrack } from '../models/ResponseTrack';
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. <br> Please remember that the track's distance must be greater than 0.
* @param requestBody CreateTrack
* @returns ResponseTrack
* @throws ApiError
*/
static trackControllerPost(requestBody?: CreateTrack): Promise<ResponseTrack>;
/**
* Get one
* Lists all information about the track whose id got provided.
* @param id
* @returns ResponseTrack
* @throws ApiError
*/
static trackControllerGetOne(id: number): Promise<ResponseTrack>;
/**
* Put
* Update the track whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody Track
* @returns ResponseTrack
* @throws ApiError
*/
static trackControllerPut(id: number, requestBody?: Track): Promise<ResponseTrack>;
/**
* Remove
* 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
* @throws ApiError
*/
static trackControllerRemove(id: number): Promise<ResponseTrack | ResponseEmpty>;
}

80
dist/services/TrackService.js vendored
View File

@@ -1,80 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.TrackService = void 0;
const request_1 = require("../core/request");
class TrackService {
/**
* Get all
* Lists all tracks.
* @returns ResponseTrack
* @throws ApiError
*/
static async trackControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/tracks`,
});
return result.body;
}
/**
* Post
* Create a new track. <br> Please remember that the track's distance must be greater than 0.
* @param requestBody CreateTrack
* @returns ResponseTrack
* @throws ApiError
*/
static async trackControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/tracks`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the track whose id got provided.
* @param id
* @returns ResponseTrack
* @throws ApiError
*/
static async trackControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/tracks/${id}`,
});
return result.body;
}
/**
* Put
* Update the track whose id you provided. <br> Please remember that ids can't be changed.
* @param id
* @param requestBody Track
* @returns ResponseTrack
* @throws ApiError
*/
static async trackControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/tracks/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @throws ApiError
*/
static async trackControllerRemove(id) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/tracks/${id}`,
});
return result.body;
}
}
exports.TrackService = TrackService;

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

@@ -1,49 +0,0 @@
import type { CreateUserGroup } from '../models/CreateUserGroup';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseUserGroup } from '../models/ResponseUserGroup';
import type { UserGroup } from '../models/UserGroup';
import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
export declare class UserGroupService {
/**
* Get all
* 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 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
*/
static userGroupControllerPost(requestBody?: CreateUserGroup): Promise<(UserGroup | UserGroupNotFoundError)>;
/**
* 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 UserGroup
* @throws ApiError
*/
static userGroupControllerGetOne(id: number): Promise<UserGroup>;
/**
* Put
* 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
* @throws ApiError
*/
static userGroupControllerPut(id: number, requestBody?: UserGroup): Promise<UserGroup>;
/**
* Remove
* 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
* @throws ApiError
*/
static userGroupControllerRemove(id: number, force?: boolean): Promise<ResponseUserGroup | ResponseEmpty>;
}

84
dist/services/UserGroupService.js vendored
View File

@@ -1,84 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserGroupService = void 0;
const request_1 = require("../core/request");
class UserGroupService {
/**
* Get all
* Lists all groups. <br> The information provided might change while the project continues to evolve.
* @returns UserGroup
* @throws ApiError
*/
static async userGroupControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/usergroups`,
});
return result.body;
}
/**
* 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
* @throws ApiError
*/
static async userGroupControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/usergroups`,
body: requestBody,
});
return result.body;
}
/**
* 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 UserGroup
* @throws ApiError
*/
static async userGroupControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/usergroups/${id}`,
});
return result.body;
}
/**
* Put
* 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
* @throws ApiError
*/
static async userGroupControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/usergroups/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @throws ApiError
*/
static async userGroupControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/usergroups/${id}`,
query: {
'force': force,
},
});
return result.body;
}
}
exports.UserGroupService = UserGroupService;

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

@@ -1,49 +0,0 @@
import type { CreateUser } from '../models/CreateUser';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { UpdateUser } from '../models/UpdateUser';
import type { User } from '../models/User';
import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
export declare class UserService {
/**
* Get all
* 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. <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
*/
static userControllerPost(requestBody?: CreateUser): Promise<(User | UserGroupNotFoundError)>;
/**
* Get one
* 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
*/
static userControllerGetOne(id: number): Promise<User>;
/**
* Put
* 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
* @throws ApiError
*/
static userControllerPut(id: number, requestBody?: UpdateUser): Promise<User>;
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static userControllerRemove(id: number, force?: boolean): Promise<User | ResponseEmpty>;
}

84
dist/services/UserService.js vendored
View File

@@ -1,84 +0,0 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.UserService = void 0;
const request_1 = require("../core/request");
class UserService {
/**
* Get all
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
* @returns User
* @throws ApiError
*/
static async userControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/users`,
});
return result.body;
}
/**
* 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 any
* @throws ApiError
*/
static async userControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/users`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* 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
*/
static async userControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/users/${id}`,
});
return result.body;
}
/**
* Put
* 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
* @throws ApiError
*/
static async userControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/users/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @returns ResponseEmpty
* @throws ApiError
*/
static async userControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/users/${id}`,
query: {
'force': force,
},
});
return result.body;
}
}
exports.UserService = UserService;