traccar-api

/** * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git */ import { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { Event } from '../models'; import { Position } from '../models'; import { ReportStops } from '../models'; import { ReportSummary } from '../models'; import { ReportTrips } from '../models'; /** * ReportsApi - axios parameter creator * @export */ export declare const ReportsApiAxiosParamCreator: (configuration?: Configuration) => { /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Events within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {Array<string>} [type] % can be used to return events of all types * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsEventsGet: (from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, type?: Array<string>, options?: any) => Promise<RequestArgs>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Positions within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsRouteGet: (from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any) => Promise<RequestArgs>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportStops within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsStopsGet: (from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any) => Promise<RequestArgs>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportSummary within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsSummaryGet: (from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any) => Promise<RequestArgs>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportTrips within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsTripsGet: (from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any) => Promise<RequestArgs>; }; /** * ReportsApi - functional programming interface * @export */ export declare const ReportsApiFp: (configuration?: Configuration) => { /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Events within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {Array<string>} [type] % can be used to return events of all types * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsEventsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, type?: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Event>>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Positions within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsRouteGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Position>>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportStops within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsStopsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReportStops>>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportSummary within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsSummaryGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReportSummary>>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportTrips within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsTripsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ReportTrips>>>; }; /** * ReportsApi - factory interface * @export */ export declare const ReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Events within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {Array<string>} [type] % can be used to return events of all types * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsEventsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, type?: Array<string>, options?: any): AxiosPromise<Array<Event>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Positions within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsRouteGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): AxiosPromise<Array<Position>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportStops within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsStopsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): AxiosPromise<Array<ReportStops>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportSummary within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsSummaryGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): AxiosPromise<Array<ReportSummary>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportTrips within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} */ reportsTripsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): AxiosPromise<Array<ReportTrips>>; }; /** * ReportsApi - object-oriented interface * @export * @class ReportsApi * @extends {BaseAPI} */ export declare class ReportsApi extends BaseAPI { /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Events within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {Array<string>} [type] % can be used to return events of all types * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ reportsEventsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, type?: Array<string>, options?: any): Promise<import("axios").AxiosResponse<Event[]>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of Positions within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ reportsRouteGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<import("axios").AxiosResponse<Position[]>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportStops within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ reportsStopsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<import("axios").AxiosResponse<ReportStops[]>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportSummary within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ reportsSummaryGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<import("axios").AxiosResponse<ReportSummary[]>>; /** * At least one _deviceId_ or one _groupId_ must be passed * @summary Fetch a list of ReportTrips within the time period for the Devices or Groups * @param {Date} from in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Date} to in IS0 8601 format. eg. `1963-11-22T18:30:00Z` * @param {Array<number>} [deviceId] * @param {Array<number>} [groupId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReportsApi */ reportsTripsGet(from: Date, to: Date, deviceId?: Array<number>, groupId?: Array<number>, options?: any): Promise<import("axios").AxiosResponse<ReportTrips[]>>; }