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

new lib version [CI SKIP]

Browse Source
This commit is contained in:
Nicolai Ort
2021-01-10 17:19:49 +00:00
parent 7efff57b5d
commit 73636cbce4
45 changed files with 302 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
dist/services/ScanService.d.ts vendored
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>;
}