traccar-api/dist/apis/devices-api.d.ts

traccar-api-client

/**
 * Traccar
 * Traccar GPS tracking server API documentation. To use the API you need to have a server instance. For testing purposes you can use one of free [demo servers](https://www.traccar.org/demo-server/). For production use you can install your own server or get a [subscription service](https://www.traccar.org/product/tracking-server/).
 *
 * OpenAPI spec version: 4.11
 * Contact: support@traccar.org
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { Device } from '../models';
import { DeviceAccumulators } from '../models';
/**
 * DevicesApi - axios parameter creator
 * @export
 */
export declare const DevicesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Without any params, returns a list of the user's devices
     * @summary Fetch a list of Devices
     * @param {boolean} [all] Can only be used by admins or managers to fetch all entities
     * @param {number} [userId] Standard users can use this only with their own _userId_
     * @param {number} [id] To fetch one or more devices. Multiple params can be passed like `id=31&id=42`
     * @param {string} [uniqueId] To fetch one or more devices. Multiple params can be passed like `uniqueId=333331&uniqieId=44442`
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesGet: (all?: boolean, userId?: number, id?: number, uniqueId?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update total distance and hours of the Device
     * @param {DeviceAccumulators} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdAccumulatorsPut: (body: DeviceAccumulators, id: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete a Device
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdDelete: (id: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update a Device
     * @param {Device} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdPut: (body: Device, id: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Create a Device
     * @param {Device} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesPost: (body: Device, options?: any) => Promise<RequestArgs>;
};
/**
 * DevicesApi - functional programming interface
 * @export
 */
export declare const DevicesApiFp: (configuration?: Configuration) => {
    /**
     * Without any params, returns a list of the user's devices
     * @summary Fetch a list of Devices
     * @param {boolean} [all] Can only be used by admins or managers to fetch all entities
     * @param {number} [userId] Standard users can use this only with their own _userId_
     * @param {number} [id] To fetch one or more devices. Multiple params can be passed like &#x60;id&#x3D;31&amp;id&#x3D;42&#x60;
     * @param {string} [uniqueId] To fetch one or more devices. Multiple params can be passed like &#x60;uniqueId&#x3D;333331&amp;uniqieId&#x3D;44442&#x60;
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesGet(all?: boolean, userId?: number, id?: number, uniqueId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Device>>>;
    /**
     *
     * @summary Update total distance and hours of the Device
     * @param {DeviceAccumulators} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdAccumulatorsPut(body: DeviceAccumulators, id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Delete a Device
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdDelete(id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Update a Device
     * @param {Device} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdPut(body: Device, id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Device>>;
    /**
     *
     * @summary Create a Device
     * @param {Device} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesPost(body: Device, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Device>>;
};
/**
 * DevicesApi - factory interface
 * @export
 */
export declare const DevicesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Without any params, returns a list of the user's devices
     * @summary Fetch a list of Devices
     * @param {boolean} [all] Can only be used by admins or managers to fetch all entities
     * @param {number} [userId] Standard users can use this only with their own _userId_
     * @param {number} [id] To fetch one or more devices. Multiple params can be passed like &#x60;id&#x3D;31&amp;id&#x3D;42&#x60;
     * @param {string} [uniqueId] To fetch one or more devices. Multiple params can be passed like &#x60;uniqueId&#x3D;333331&amp;uniqieId&#x3D;44442&#x60;
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesGet(all?: boolean, userId?: number, id?: number, uniqueId?: string, options?: any): AxiosPromise<Array<Device>>;
    /**
     *
     * @summary Update total distance and hours of the Device
     * @param {DeviceAccumulators} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdAccumulatorsPut(body: DeviceAccumulators, id: number, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Delete a Device
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdDelete(id: number, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Update a Device
     * @param {Device} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesIdPut(body: Device, id: number, options?: any): AxiosPromise<Device>;
    /**
     *
     * @summary Create a Device
     * @param {Device} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    devicesPost(body: Device, options?: any): AxiosPromise<Device>;
};
/**
 * DevicesApi - object-oriented interface
 * @export
 * @class DevicesApi
 * @extends {BaseAPI}
 */
export declare class DevicesApi extends BaseAPI {
    /**
     * Without any params, returns a list of the user's devices
     * @summary Fetch a list of Devices
     * @param {boolean} [all] Can only be used by admins or managers to fetch all entities
     * @param {number} [userId] Standard users can use this only with their own _userId_
     * @param {number} [id] To fetch one or more devices. Multiple params can be passed like &#x60;id&#x3D;31&amp;id&#x3D;42&#x60;
     * @param {string} [uniqueId] To fetch one or more devices. Multiple params can be passed like &#x60;uniqueId&#x3D;333331&amp;uniqieId&#x3D;44442&#x60;
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    devicesGet(all?: boolean, userId?: number, id?: number, uniqueId?: string, options?: any): Promise<import("axios").AxiosResponse<Device[]>>;
    /**
     *
     * @summary Update total distance and hours of the Device
     * @param {DeviceAccumulators} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    devicesIdAccumulatorsPut(body: DeviceAccumulators, id: number, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @summary Delete a Device
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    devicesIdDelete(id: number, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @summary Update a Device
     * @param {Device} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    devicesIdPut(body: Device, id: number, options?: any): Promise<import("axios").AxiosResponse<Device>>;
    /**
     *
     * @summary Create a Device
     * @param {Device} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof DevicesApi
     */
    devicesPost(body: Device, options?: any): Promise<import("axios").AxiosResponse<Device>>;
}