traccar-api
Version:
traccar-api-client
141 lines (140 loc) • 4.87 kB
TypeScript
/**
* 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 { User } from '../models';
/**
* SessionApi - axios parameter creator
* @export
*/
export declare const SessionApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionDelete: (options?: any) => Promise<RequestArgs>;
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionGet: (token?: string, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Create a new Session
* @param {string} email
* @param {string} password
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionPost: (email: string, password: string, options?: any) => Promise<RequestArgs>;
};
/**
* SessionApi - functional programming interface
* @export
*/
export declare const SessionApiFp: (configuration?: Configuration) => {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionDelete(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionGet(token?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
/**
*
* @summary Create a new Session
* @param {string} email
* @param {string} password
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionPost(email: string, password: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
};
/**
* SessionApi - factory interface
* @export
*/
export declare const SessionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionDelete(options?: any): AxiosPromise<void>;
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionGet(token?: string, options?: any): AxiosPromise<User>;
/**
*
* @summary Create a new Session
* @param {string} email
* @param {string} password
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionPost(email: string, password: string, options?: any): AxiosPromise<User>;
};
/**
* SessionApi - object-oriented interface
* @export
* @class SessionApi
* @extends {BaseAPI}
*/
export declare class SessionApi extends BaseAPI {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SessionApi
*/
sessionDelete(options?: any): Promise<import("axios").AxiosResponse<void>>;
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SessionApi
*/
sessionGet(token?: string, options?: any): Promise<import("axios").AxiosResponse<User>>;
/**
*
* @summary Create a new Session
* @param {string} email
* @param {string} password
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SessionApi
*/
sessionPost(email: string, password: string, options?: any): Promise<import("axios").AxiosResponse<User>>;
}