traccar-api/dist/apis/users-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 { User } from '../models';
/**
 * UsersApi - axios parameter creator
 * @export
 */
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Fetch a list of Users
     * @param {string} [userId] Can only be used by admin or manager users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersGet: (userId?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete a User
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersIdDelete: (id: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Update a User
     * @param {User} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersIdPut: (body: User, id: number, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @summary Create a User
     * @param {User} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersPost: (body: User, options?: any) => Promise<RequestArgs>;
};
/**
 * UsersApi - functional programming interface
 * @export
 */
export declare const UsersApiFp: (configuration?: Configuration) => {
    /**
     *
     * @summary Fetch a list of Users
     * @param {string} [userId] Can only be used by admin or manager users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersGet(userId?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<User>>>;
    /**
     *
     * @summary Delete a User
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersIdDelete(id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @summary Update a User
     * @param {User} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersIdPut(body: User, id: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
    /**
     *
     * @summary Create a User
     * @param {User} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersPost(body: User, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<User>>;
};
/**
 * UsersApi - factory interface
 * @export
 */
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @summary Fetch a list of Users
     * @param {string} [userId] Can only be used by admin or manager users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersGet(userId?: string, options?: any): AxiosPromise<Array<User>>;
    /**
     *
     * @summary Delete a User
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersIdDelete(id: number, options?: any): AxiosPromise<void>;
    /**
     *
     * @summary Update a User
     * @param {User} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersIdPut(body: User, id: number, options?: any): AxiosPromise<User>;
    /**
     *
     * @summary Create a User
     * @param {User} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    usersPost(body: User, options?: any): AxiosPromise<User>;
};
/**
 * UsersApi - object-oriented interface
 * @export
 * @class UsersApi
 * @extends {BaseAPI}
 */
export declare class UsersApi extends BaseAPI {
    /**
     *
     * @summary Fetch a list of Users
     * @param {string} [userId] Can only be used by admin or manager users
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    usersGet(userId?: string, options?: any): Promise<import("axios").AxiosResponse<User[]>>;
    /**
     *
     * @summary Delete a User
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    usersIdDelete(id: number, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @summary Update a User
     * @param {User} body
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    usersIdPut(body: User, id: number, options?: any): Promise<import("axios").AxiosResponse<User>>;
    /**
     *
     * @summary Create a User
     * @param {User} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    usersPost(body: User, options?: any): Promise<import("axios").AxiosResponse<User>>;
}