lfk-client-js/dist/services/ScanService.js
Nicolai Ort 9b6d686d93
All checks were successful
continuous-integration/drone Build is passing
🚀New lib version v0.13.1 [CI SKIP]
2023-02-02 15:19:00 +00:00

116 lines
3.7 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ScanService = void 0;
const request_1 = require("../core/request");
class ScanService {
/**
* Get all
* Lists all scans (normal or track) from all runners. <br> This includes the scan's runner's distance ran.
* @result any
* @throws ApiError
*/
static async scanControllerGetAll() {
const result = await (0, request_1.request)({
method: 'GET',
path: `/api/scans`,
});
return result.body;
}
/**
* 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
* @result ResponseScan
* @throws ApiError
*/
static async scanControllerPost(requestBody) {
const result = await (0, request_1.request)({
method: 'POST',
path: `/api/scans`,
body: requestBody,
});
return result.body;
}
/**
* Get one
* Lists all information about the scan whose id got provided. This includes the scan's runner's distance ran.
* @param id
* @result any
* @throws ApiError
*/
static async scanControllerGetOne(id) {
const result = await (0, request_1.request)({
method: 'GET',
path: `/api/scans/${id}`,
});
return result.body;
}
/**
* Put
* 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
* @result ResponseScan
* @throws ApiError
*/
static async scanControllerPut(id, requestBody) {
const result = await (0, request_1.request)({
method: 'PUT',
path: `/api/scans/${id}`,
body: requestBody,
});
return result.body;
}
/**
* Remove
* 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
* @result ResponseScan
* @result ResponseEmpty
* @throws ApiError
*/
static async scanControllerRemove(id, force) {
const result = await (0, request_1.request)({
method: 'DELETE',
path: `/api/scans/${id}`,
query: {
'force': force,
},
});
return result.body;
}
/**
* 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
* @result ResponseTrackScan
* @throws ApiError
*/
static async scanControllerPostTrackScans(requestBody) {
const result = await (0, request_1.request)({
method: 'POST',
path: `/api/scans/trackscans`,
body: requestBody,
});
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
* @result ResponseTrackScan
* @throws ApiError
*/
static async scanControllerPutTrackScan(id, requestBody) {
const result = await (0, request_1.request)({
method: 'PUT',
path: `/api/scans/trackscans/${id}`,
body: requestBody,
});
return result.body;
}
}
exports.ScanService = ScanService;