49 lines
2.2 KiB
TypeScript
49 lines
2.2 KiB
TypeScript
import type { CreateScanStation } from '../models/CreateScanStation';
|
|
import type { ResponseEmpty } from '../models/ResponseEmpty';
|
|
import type { ResponseScanStation } from '../models/ResponseScanStation';
|
|
import type { UpdateScanStation } from '../models/UpdateScanStation';
|
|
export declare class ScanStationService {
|
|
/**
|
|
* Get all
|
|
* Lists all stations. <br> This includes their associated tracks.
|
|
* @returns ResponseScanStation
|
|
* @throws ApiError
|
|
*/
|
|
static scanStationControllerGetAll(): Promise<Array<ResponseScanStation>>;
|
|
/**
|
|
* 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
|
|
* @throws ApiError
|
|
*/
|
|
static scanStationControllerPost(requestBody?: CreateScanStation): Promise<ResponseScanStation>;
|
|
/**
|
|
* Get one
|
|
* Lists all information about the station whose id got provided. <br> This includes it's associated track.
|
|
* @param id
|
|
* @returns ResponseScanStation
|
|
* @throws ApiError
|
|
*/
|
|
static scanStationControllerGetOne(id: number): Promise<ResponseScanStation>;
|
|
/**
|
|
* Put
|
|
* 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
|
|
* @throws ApiError
|
|
*/
|
|
static scanStationControllerPut(id: number, requestBody?: UpdateScanStation): Promise<ResponseScanStation>;
|
|
/**
|
|
* Remove
|
|
* 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
|
|
* @throws ApiError
|
|
*/
|
|
static scanStationControllerRemove(id: number, force?: boolean): Promise<ResponseScanStation | ResponseEmpty>;
|
|
}
|