new lib version [CI SKIP]

This commit is contained in:
2021-01-10 17:19:49 +00:00
parent 7efff57b5d
commit 73636cbce4
45 changed files with 302 additions and 38 deletions

View File

@@ -1,4 +1,3 @@
import type { Auth } from '../models/Auth';
import type { CreateAuth } from '../models/CreateAuth';
import type { CreateResetToken } from '../models/CreateResetToken';
import type { HandleLogout } from '../models/HandleLogout';
@@ -10,6 +9,7 @@ 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 { ResponseAuth } from '../models/ResponseAuth';
import type { UsernameOrEmailNeededError } from '../models/UsernameOrEmailNeededError';
import type { UserNotFoundError } from '../models/UserNotFoundError';
export declare class AuthService {
@@ -22,7 +22,7 @@ export declare class AuthService {
* @returns any
* @throws ApiError
*/
static authControllerLogin(requestBody?: CreateAuth): Promise<(Auth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
static authControllerLogin(requestBody?: CreateAuth): Promise<(ResponseAuth | InvalidCredentialsError | UserNotFoundError | UsernameOrEmailNeededError | PasswordNeededError)>;
/**
* Logout
* Logout using your refresh token. <br> This instantly invalidates all your access and refresh tokens.
@@ -40,7 +40,7 @@ export declare class AuthService {
* @returns any
* @throws ApiError
*/
static authControllerRefresh(requestBody?: RefreshAuth): Promise<(Auth | JwtNotProvidedError | IllegalJWTError | UserNotFoundError | RefreshTokenCountInvalidError)>;
static authControllerRefresh(requestBody?: RefreshAuth): Promise<(ResponseAuth | 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}.
@@ -48,7 +48,7 @@ export declare class AuthService {
* @returns any
* @throws ApiError
*/
static authControllerGetResetToken(requestBody?: CreateResetToken): Promise<(Auth | UserNotFoundError | UsernameOrEmailNeededError)>;
static authControllerGetResetToken(requestBody?: CreateResetToken): Promise<(ResponseAuth | 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.
@@ -57,5 +57,5 @@ export declare class AuthService {
* @returns any
* @throws ApiError
*/
static authControllerResetPassword(token: string, requestBody?: ResetPassword): Promise<(Auth | UserNotFoundError | UsernameOrEmailNeededError)>;
static authControllerResetPassword(token: string, requestBody?: ResetPassword): Promise<(ResponseAuth | UserNotFoundError | UsernameOrEmailNeededError)>;
}

48
dist/services/RunnerCardService.d.ts vendored Normal file
View File

@@ -0,0 +1,48 @@
import type { CreateRunnerCard } from '../models/CreateRunnerCard';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseRunnerCard } from '../models/ResponseRunnerCard';
import type { UpdateRunnerCard } from '../models/UpdateRunnerCard';
export declare class RunnerCardService {
/**
* Get all
* Lists all card.
* @returns ResponseRunnerCard
* @throws ApiError
*/
static runnerCardControllerGetAll(): Promise<Array<ResponseRunnerCard>>;
/**
* 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
* @throws ApiError
*/
static runnerCardControllerPost(requestBody?: CreateRunnerCard): Promise<ResponseRunnerCard>;
/**
* Get one
* Lists all information about the card whose id got provided.
* @param id
* @returns ResponseRunnerCard
* @throws ApiError
*/
static runnerCardControllerGetOne(id: number): Promise<ResponseRunnerCard>;
/**
* Put
* 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
* @throws ApiError
*/
static runnerCardControllerPut(id: number, requestBody?: UpdateRunnerCard): Promise<ResponseRunnerCard>;
/**
* Remove
* 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
* @throws ApiError
*/
static runnerCardControllerRemove(id: number, force?: boolean): Promise<ResponseRunnerCard | ResponseEmpty>;
}

84
dist/services/RunnerCardService.js vendored Normal file
View File

@@ -0,0 +1,84 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.RunnerCardService = void 0;
const request_1 = require("../core/request");
class RunnerCardService {
/**
* Get all
* Lists all card.
* @returns ResponseRunnerCard
* @throws ApiError
*/
static async runnerCardControllerGetAll() {
const result = await request_1.request({
method: 'GET',
path: `/api/cards`,
});
return result.body;
}
/**
* 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
* @throws ApiError
*/
static async runnerCardControllerPost(requestBody) {
const result = await request_1.request({
method: 'POST',
path: `/api/cards`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the card whose id got provided.
* @param id
* @returns ResponseRunnerCard
* @throws ApiError
*/
static async runnerCardControllerGetOne(id) {
const result = await request_1.request({
method: 'GET',
path: `/api/cards/${id}`,
});
return result.body;
}
/**
* Put
* 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
* @throws ApiError
*/
static async runnerCardControllerPut(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/cards/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @throws ApiError
*/
static async runnerCardControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/cards/${id}`,
query: {
'force': force,
},
});
return result.body;
}
}
exports.RunnerCardService = RunnerCardService;

View File

@@ -39,7 +39,7 @@ export declare class RunnerService {
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).
* 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

View File

@@ -63,7 +63,7 @@ class RunnerService {
}
/**
* Remove
* Delete the runner whose id you provided. <br> If no runner with this id exists it will just return 204(no content).
* 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

View File

@@ -4,6 +4,7 @@ import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseScan } from '../models/ResponseScan';
import type { ResponseTrackScan } from '../models/ResponseTrackScan';
import type { UpdateScan } from '../models/UpdateScan';
import type { UpdateTrackScan } from '../models/UpdateTrackScan';
export declare class ScanService {
/**
* Get all
@@ -14,7 +15,7 @@ export declare class ScanService {
static scanControllerGetAll(): Promise<(Array<ResponseScan> | Array<ResponseTrackScan>)>;
/**
* Post
* Create a new scan. <br> Please remeber to provide the scan's runner's id and distance for normal scans.
* 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
* @throws ApiError
@@ -30,7 +31,7 @@ export declare class ScanService {
static scanControllerGetOne(id: number): Promise<(ResponseScan | ResponseTrackScan)>;
/**
* Put
* Update the scan whose id you provided. <br> Please remember that ids can't be changed and distances must be positive.
* 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
@@ -49,10 +50,19 @@ export declare class ScanService {
static scanControllerRemove(id: number, force?: boolean): Promise<ResponseScan | ResponseEmpty>;
/**
* Post track scans
* Create a new track scan. <br> This is just a alias for posting /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 ResponseScan
* @returns ResponseTrackScan
* @throws ApiError
*/
static scanControllerPostTrackScans(requestBody?: CreateTrackScan): Promise<ResponseScan>;
static scanControllerPostTrackScans(requestBody?: CreateTrackScan): Promise<ResponseTrackScan>;
/**
* Put track scan
* 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
* @throws ApiError
*/
static scanControllerPutTrackScan(id: number, requestBody?: UpdateTrackScan): Promise<ResponseTrackScan>;
}

View File

@@ -18,7 +18,7 @@ class ScanService {
}
/**
* Post
* Create a new scan. <br> Please remeber to provide the scan's runner's id and distance for normal scans.
* 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
* @throws ApiError
@@ -47,7 +47,7 @@ class ScanService {
}
/**
* Put
* Update the scan whose id you provided. <br> Please remember that ids can't be changed and distances must be positive.
* 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
@@ -82,9 +82,9 @@ class ScanService {
}
/**
* Post track scans
* Create a new track scan. <br> This is just a alias for posting /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 ResponseScan
* @returns ResponseTrackScan
* @throws ApiError
*/
static async scanControllerPostTrackScans(requestBody) {
@@ -95,5 +95,21 @@ class ScanService {
});
return result.body;
}
/**
* Put track scan
* 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
* @throws ApiError
*/
static async scanControllerPutTrackScan(id, requestBody) {
const result = await request_1.request({
method: 'PUT',
path: `/api/scans/trackscans/${id}`,
body: requestBody,
});
return result.body;
}
}
exports.ScanService = ScanService;

View File

@@ -29,9 +29,10 @@ export declare class StatsClientService {
* 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
* @param force
* @returns ResponseStatsClient
* @returns ResponseEmpty
* @throws ApiError
*/
static statsClientControllerRemove(id: number): Promise<ResponseStatsClient | ResponseEmpty>;
static statsClientControllerRemove(id: number, force?: boolean): Promise<ResponseStatsClient | ResponseEmpty>;
}

View File

@@ -49,14 +49,18 @@ class StatsClientService {
* 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
* @param force
* @returns ResponseStatsClient
* @returns ResponseEmpty
* @throws ApiError
*/
static async statsClientControllerRemove(id) {
static async statsClientControllerRemove(id, force) {
const result = await request_1.request({
method: 'DELETE',
path: `/api/statsclients/${id}`,
query: {
'force': force,
},
});
return result.body;
}

View File

@@ -1,6 +1,7 @@
import type { CreateUserGroup } from '../models/CreateUserGroup';
import type { ResponseEmpty } from '../models/ResponseEmpty';
import type { ResponseUserGroup } from '../models/ResponseUserGroup';
import type { UpdateUserGroup } from '../models/UpdateUserGroup';
import type { UserGroup } from '../models/UserGroup';
import type { UserGroupNotFoundError } from '../models/UserGroupNotFoundError';
export declare class UserGroupService {
@@ -31,11 +32,11 @@ export declare class UserGroupService {
* 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
* @param requestBody UpdateUserGroup
* @returns UserGroup
* @throws ApiError
*/
static userGroupControllerPut(id: number, requestBody?: UserGroup): Promise<UserGroup>;
static userGroupControllerPut(id: number, requestBody?: UpdateUserGroup): 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).

View File

@@ -49,7 +49,7 @@ class UserGroupService {
* 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
* @param requestBody UpdateUserGroup
* @returns UserGroup
* @throws ApiError
*/