traccar-api
Version:
traccar-api-client
294 lines (278 loc) • 12.9 kB
text/typescript
/* tslint:disable */
/* eslint-disable */
/**
* 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 globalAxios, { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
// Some imports not used depending on template conditions
// @ts-ignore
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
import { User } from '../models';
/**
* SessionApi - axios parameter creator
* @export
*/
export const SessionApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionDelete: async (options: any = {}): Promise<RequestArgs> => {
const localVarPath = `/session`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionGet: async (token?: string, options: any = {}): Promise<RequestArgs> => {
const localVarPath = `/session`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication basicAuth required
if (token !== undefined) {
localVarQueryParameter['token'] = token;
}
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
/**
*
* @summary Create a new Session
* @param {string} email
* @param {string} password
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionPost: async (email: string, password: string, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'email' is not null or undefined
if (email === null || email === undefined) {
throw new RequiredError('email','Required parameter email was null or undefined when calling sessionPost.');
}
// verify required parameter 'password' is not null or undefined
if (password === null || password === undefined) {
throw new RequiredError('password','Required parameter password was null or undefined when calling sessionPost.');
}
const localVarPath = `/session`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, 'https://example.com');
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
const localVarFormParams = new URLSearchParams();
// authentication basicAuth required
if (email !== undefined) {
localVarFormParams.set('email', email as any);
}
if (password !== undefined) {
localVarFormParams.set('password', password as any);
}
localVarHeaderParameter['Content-Type'] = 'application/x-www-form-urlencoded';
const query = new URLSearchParams(localVarUrlObj.search);
for (const key in localVarQueryParameter) {
query.set(key, localVarQueryParameter[key]);
}
for (const key in options.query) {
query.set(key, options.query[key]);
}
localVarUrlObj.search = (new URLSearchParams(query)).toString();
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = localVarFormParams.toString();
return {
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash,
options: localVarRequestOptions,
};
},
}
};
/**
* SessionApi - functional programming interface
* @export
*/
export const SessionApiFp = function(configuration?: Configuration) {
return {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async sessionDelete(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
const localVarAxiosArgs = await SessionApiAxiosParamCreator(configuration).sessionDelete(options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async sessionGet(token?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>> {
const localVarAxiosArgs = await SessionApiAxiosParamCreator(configuration).sessionGet(token, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
/**
*
* @summary Create a new Session
* @param {string} email
* @param {string} password
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async sessionPost(email: string, password: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>> {
const localVarAxiosArgs = await SessionApiAxiosParamCreator(configuration).sessionPost(email, password, options);
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url};
return axios.request(axiosRequestArgs);
};
},
}
};
/**
* SessionApi - factory interface
* @export
*/
export const SessionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
return {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionDelete(options?: any): AxiosPromise<void> {
return SessionApiFp(configuration).sessionDelete(options).then((request) => request(axios, basePath));
},
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
sessionGet(token?: string, options?: any): AxiosPromise<User> {
return SessionApiFp(configuration).sessionGet(token, options).then((request) => request(axios, basePath));
},
/**
*
* @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> {
return SessionApiFp(configuration).sessionPost(email, password, options).then((request) => request(axios, basePath));
},
};
};
/**
* SessionApi - object-oriented interface
* @export
* @class SessionApi
* @extends {BaseAPI}
*/
export class SessionApi extends BaseAPI {
/**
*
* @summary Close the Session
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SessionApi
*/
public sessionDelete(options?: any) {
return SessionApiFp(this.configuration).sessionDelete(options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Fetch Session information
* @param {string} [token]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SessionApi
*/
public sessionGet(token?: string, options?: any) {
return SessionApiFp(this.configuration).sessionGet(token, options).then((request) => request(this.axios, this.basePath));
}
/**
*
* @summary Create a new Session
* @param {string} email
* @param {string} password
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SessionApi
*/
public sessionPost(email: string, password: string, options?: any) {
return SessionApiFp(this.configuration).sessionPost(email, password, options).then((request) => request(this.axios, this.basePath));
}
}