traccar-api
Version:
traccar-api-client
253 lines (252 loc) • 11 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 { Notification } from '../models';
import { NotificationType } from '../models';
/**
* NotificationsApi - axios parameter creator
* @export
*/
export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Without params, it returns a list of Notifications the user has access to
* @summary Fetch a list of Notifications
* @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}
*/
notificationsGet: (all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Delete a Notification
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsIdDelete: (id: number, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Update a Notification
* @param {Notification} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsIdPut: (body: Notification, id: number, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Create a Notification
* @param {Notification} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsPost: (body: Notification, options?: any) => Promise<RequestArgs>;
/**
*
* @summary Send test notification to current user via Email and SMS
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsTestPost: (options?: any) => Promise<RequestArgs>;
/**
*
* @summary Fetch a list of available Notification types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsTypesGet: (options?: any) => Promise<RequestArgs>;
};
/**
* NotificationsApi - functional programming interface
* @export
*/
export declare const NotificationsApiFp: (configuration?: Configuration) => {
/**
* Without params, it returns a list of Notifications the user has access to
* @summary Fetch a list of Notifications
* @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}
*/
notificationsGet(all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Notification>>>;
/**
*
* @summary Delete a Notification
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsIdDelete(id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Update a Notification
* @param {Notification} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsIdPut(body: Notification, id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
/**
*
* @summary Create a Notification
* @param {Notification} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsPost(body: Notification, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
/**
*
* @summary Send test notification to current user via Email and SMS
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsTestPost(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Fetch a list of available Notification types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsTypesGet(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NotificationType>>>;
};
/**
* NotificationsApi - factory interface
* @export
*/
export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Without params, it returns a list of Notifications the user has access to
* @summary Fetch a list of Notifications
* @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}
*/
notificationsGet(all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any): AxiosPromise<Array<Notification>>;
/**
*
* @summary Delete a Notification
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsIdDelete(id: number, options?: any): AxiosPromise<void>;
/**
*
* @summary Update a Notification
* @param {Notification} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsIdPut(body: Notification, id: number, options?: any): AxiosPromise<Notification>;
/**
*
* @summary Create a Notification
* @param {Notification} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsPost(body: Notification, options?: any): AxiosPromise<Notification>;
/**
*
* @summary Send test notification to current user via Email and SMS
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsTestPost(options?: any): AxiosPromise<void>;
/**
*
* @summary Fetch a list of available Notification types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
notificationsTypesGet(options?: any): AxiosPromise<Array<NotificationType>>;
};
/**
* NotificationsApi - object-oriented interface
* @export
* @class NotificationsApi
* @extends {BaseAPI}
*/
export declare class NotificationsApi extends BaseAPI {
/**
* Without params, it returns a list of Notifications the user has access to
* @summary Fetch a list of Notifications
* @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 NotificationsApi
*/
notificationsGet(all?: boolean, userId?: number, deviceId?: number, groupId?: number, refresh?: boolean, options?: any): Promise<import("axios").AxiosResponse<Notification[]>>;
/**
*
* @summary Delete a Notification
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
notificationsIdDelete(id: number, options?: any): Promise<import("axios").AxiosResponse<void>>;
/**
*
* @summary Update a Notification
* @param {Notification} body
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
notificationsIdPut(body: Notification, id: number, options?: any): Promise<import("axios").AxiosResponse<Notification>>;
/**
*
* @summary Create a Notification
* @param {Notification} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
notificationsPost(body: Notification, options?: any): Promise<import("axios").AxiosResponse<Notification>>;
/**
*
* @summary Send test notification to current user via Email and SMS
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
notificationsTestPost(options?: any): Promise<import("axios").AxiosResponse<void>>;
/**
*
* @summary Fetch a list of available Notification types
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof NotificationsApi
*/
notificationsTypesGet(options?: any): Promise<import("axios").AxiosResponse<NotificationType[]>>;
}