traccar-api/dist/apis/geofences-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 { Geofence } from '../models';
/**
 * GeofencesApi - axios parameter creator
 * @export
 */
export declare const GeofencesApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Without params, it returns a list of Geofences the user has access to
     * @summary Fetch a list of Geofences
     * @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} [deviceId] Standard users can use this only with _deviceId_s, they have access to
     * @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
     * @param {boolean} [refresh]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesGet: (all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete a Geofence
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesIdDelete: (id: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update a Geofence
     * @param {Geofence} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesIdPut: (body: Geofence, id: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Create a Geofence
     * @param {Geofence} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesPost: (body: Geofence, options?: any) => Promise<RequestArgs>;
};
/**
 * GeofencesApi - functional programming interface
 * @export
 */
export declare const GeofencesApiFp: (configuration?: Configuration) => {
    /**
     * Without params, it returns a list of Geofences the user has access to
     * @summary Fetch a list of Geofences
     * @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} [deviceId] Standard users can use this only with _deviceId_s, they have access to
     * @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
     * @param {boolean} [refresh]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesGet(all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Geofence>>>;
    /**
     *
     * @summary Delete a Geofence
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesIdDelete(id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Update a Geofence
     * @param {Geofence} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesIdPut(body: Geofence, id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Geofence>>;
    /**
     *
     * @summary Create a Geofence
     * @param {Geofence} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesPost(body: Geofence, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Geofence>>;
};
/**
 * GeofencesApi - factory interface
 * @export
 */
export declare const GeofencesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Without params, it returns a list of Geofences the user has access to
     * @summary Fetch a list of Geofences
     * @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} [deviceId] Standard users can use this only with _deviceId_s, they have access to
     * @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
     * @param {boolean} [refresh]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesGet(all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any): AxiosPromise<Array<Geofence>>;
    /**
     *
     * @summary Delete a Geofence
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesIdDelete(id: number, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Update a Geofence
     * @param {Geofence} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesIdPut(body: Geofence, id: number, options?: any): AxiosPromise<Geofence>;
    /**
     *
     * @summary Create a Geofence
     * @param {Geofence} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    geofencesPost(body: Geofence, options?: any): AxiosPromise<Geofence>;
};
/**
 * GeofencesApi - object-oriented interface
 * @export
 * @class GeofencesApi
 * @extends {BaseAPI}
 */
export declare class GeofencesApi extends BaseAPI {
    /**
     * Without params, it returns a list of Geofences the user has access to
     * @summary Fetch a list of Geofences
     * @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} [deviceId] Standard users can use this only with _deviceId_s, they have access to
     * @param {number} [groupId] Standard users can use this only with _groupId_s, they have access to
     * @param {boolean} [refresh]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof GeofencesApi
     */
    geofencesGet(all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any): Promise<import("axios").AxiosResponse<Geofence[]>>;
    /**
     *
     * @summary Delete a Geofence
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof GeofencesApi
     */
    geofencesIdDelete(id: number, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @summary Update a Geofence
     * @param {Geofence} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof GeofencesApi
     */
    geofencesIdPut(body: Geofence, id: number, options?: any): Promise<import("axios").AxiosResponse<Geofence>>;
    /**
     *
     * @summary Create a Geofence
     * @param {Geofence} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof GeofencesApi
     */
    geofencesPost(body: Geofence, options?: any): Promise<import("axios").AxiosResponse<Geofence>>;
}