/** * Webitel API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * The version of the OpenAPI document: 24.04.0 * Contact: support@webitel.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { ApiCreateUserRequest } from '../api'; import { ApiCreateUserResponse } from '../api'; import { ApiDeleteUsersResponse } from '../api'; import { ApiReadUserResponse } from '../api'; import { ApiSearchUsersRequest } from '../api'; import { ApiSearchUsersResponse } from '../api'; import { ApiUser } from '../api'; import { BodyModificationsChanges } from '../api'; import { BodyModificationsChanges1 } from '../api'; /** * UsersApi - axios parameter creator * @export */ export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @param {ApiCreateUserRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser: (body: ApiCreateUserRequest, options?: any) => Promise; /** * * @param {string} id ONE /users/{id} * @param {Array} [selection] MANY /users .ids=[id,...] * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers: (id: string, selection?: Array, permanent?: boolean, options?: any) => Promise; /** * * @param {Array} selection MANY /users .ids=[id,...] * @param {string} [id] ONE /users/{id} * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers2: (selection: Array, id?: string, permanent?: boolean, options?: any) => Promise; /** * * @param {string} id * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ logoutUser: (id: string, body: object, options?: any) => Promise; /** * * @param {string} id * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} */ readUser: (id: string, fields?: Array, options?: any) => Promise; /** * * @param {string} [id] * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} */ readUser2: (id?: string, fields?: Array, options?: any) => Promise; /** * * @param {Array} [id] ----- Base Filters --------------------------- filter: .id = any({id}...) * @param {Array} [notId] filter: .id <> all({not_ids}...) * @param {string} [q] ----- User-specific Filters ------------------ filter: (.name|.username|.extension|.status) ILIKE \'{q}\' * @param {string} [name] filter: .name ILIKE \'{name}\' * @param {string} [status] filter: .status ILIKE \'{status}\' * @param {string} [username] filter: .username ILIKE \'{username}\' * @param {string} [extension] filter: .extension LIKE \'{extension}\' * @param {boolean} [any] ----- View Modes ----------------------------- NOTE: by default, search NOT \'deleted\' objects ONLY filter: include \'deleted\' ALSO ! (inactive) * @param {boolean} [deleted] filter: .deleted_at NOTNULL (view: RECYCLE) * @param {string} [presenceStatus] * @param {string} [presenceNote] * @param {Array} [fields] // navigation filter repeated int64 roles = 7; ----- Search Options ------------------------- select: output (fields,...) * @param {Array} [sort] select: order by (fields,...) * @param {number} [page] select: offset {page} * @param {number} [size] select: limit {size} * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUsers: (id?: Array, notId?: Array, q?: string, name?: string, status?: string, username?: string, extension?: string, any?: boolean, deleted?: boolean, presenceStatus?: string, presenceNote?: string, fields?: Array, sort?: Array, page?: number, size?: number, options?: any) => Promise; /** * * @param {ApiSearchUsersRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUsers2: (body: ApiSearchUsersRequest, options?: any) => Promise; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser: (userId: string, user: BodyModificationsChanges, fields?: Array, options?: any) => Promise; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges1} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser2: (userId: string, user: BodyModificationsChanges1, fields?: Array, options?: any) => Promise; }; /** * UsersApi - functional programming interface * @export */ export declare const UsersApiFp: (configuration?: Configuration) => { /** * * @param {ApiCreateUserRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(body: ApiCreateUserRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id ONE /users/{id} * @param {Array} [selection] MANY /users .ids=[id,...] * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers(id: string, selection?: Array, permanent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} selection MANY /users .ids=[id,...] * @param {string} [id] ONE /users/{id} * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers2(selection: Array, id?: string, permanent?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ logoutUser(id: string, body: object, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} */ readUser(id: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} [id] * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} */ readUser2(id?: string, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} [id] ----- Base Filters --------------------------- filter: .id = any({id}...) * @param {Array} [notId] filter: .id <> all({not_ids}...) * @param {string} [q] ----- User-specific Filters ------------------ filter: (.name|.username|.extension|.status) ILIKE \'{q}\' * @param {string} [name] filter: .name ILIKE \'{name}\' * @param {string} [status] filter: .status ILIKE \'{status}\' * @param {string} [username] filter: .username ILIKE \'{username}\' * @param {string} [extension] filter: .extension LIKE \'{extension}\' * @param {boolean} [any] ----- View Modes ----------------------------- NOTE: by default, search NOT \'deleted\' objects ONLY filter: include \'deleted\' ALSO ! (inactive) * @param {boolean} [deleted] filter: .deleted_at NOTNULL (view: RECYCLE) * @param {string} [presenceStatus] * @param {string} [presenceNote] * @param {Array} [fields] // navigation filter repeated int64 roles = 7; ----- Search Options ------------------------- select: output (fields,...) * @param {Array} [sort] select: order by (fields,...) * @param {number} [page] select: offset {page} * @param {number} [size] select: limit {size} * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUsers(id?: Array, notId?: Array, q?: string, name?: string, status?: string, username?: string, extension?: string, any?: boolean, deleted?: boolean, presenceStatus?: string, presenceNote?: string, fields?: Array, sort?: Array, page?: number, size?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {ApiSearchUsersRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUsers2(body: ApiSearchUsersRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(userId: string, user: BodyModificationsChanges, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges1} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser2(userId: string, user: BodyModificationsChanges1, fields?: Array, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersApi - factory interface * @export */ export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @param {ApiCreateUserRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(body: ApiCreateUserRequest, options?: any): AxiosPromise; /** * * @param {string} id ONE /users/{id} * @param {Array} [selection] MANY /users .ids=[id,...] * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers(id: string, selection?: Array, permanent?: boolean, options?: any): AxiosPromise; /** * * @param {Array} selection MANY /users .ids=[id,...] * @param {string} [id] ONE /users/{id} * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUsers2(selection: Array, id?: string, permanent?: boolean, options?: any): AxiosPromise; /** * * @param {string} id * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ logoutUser(id: string, body: object, options?: any): AxiosPromise; /** * * @param {string} id * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} */ readUser(id: string, fields?: Array, options?: any): AxiosPromise; /** * * @param {string} [id] * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} */ readUser2(id?: string, fields?: Array, options?: any): AxiosPromise; /** * * @param {Array} [id] ----- Base Filters --------------------------- filter: .id = any({id}...) * @param {Array} [notId] filter: .id <> all({not_ids}...) * @param {string} [q] ----- User-specific Filters ------------------ filter: (.name|.username|.extension|.status) ILIKE \'{q}\' * @param {string} [name] filter: .name ILIKE \'{name}\' * @param {string} [status] filter: .status ILIKE \'{status}\' * @param {string} [username] filter: .username ILIKE \'{username}\' * @param {string} [extension] filter: .extension LIKE \'{extension}\' * @param {boolean} [any] ----- View Modes ----------------------------- NOTE: by default, search NOT \'deleted\' objects ONLY filter: include \'deleted\' ALSO ! (inactive) * @param {boolean} [deleted] filter: .deleted_at NOTNULL (view: RECYCLE) * @param {string} [presenceStatus] * @param {string} [presenceNote] * @param {Array} [fields] // navigation filter repeated int64 roles = 7; ----- Search Options ------------------------- select: output (fields,...) * @param {Array} [sort] select: order by (fields,...) * @param {number} [page] select: offset {page} * @param {number} [size] select: limit {size} * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUsers(id?: Array, notId?: Array, q?: string, name?: string, status?: string, username?: string, extension?: string, any?: boolean, deleted?: boolean, presenceStatus?: string, presenceNote?: string, fields?: Array, sort?: Array, page?: number, size?: number, options?: any): AxiosPromise; /** * * @param {ApiSearchUsersRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchUsers2(body: ApiSearchUsersRequest, options?: any): AxiosPromise; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(userId: string, user: BodyModificationsChanges, fields?: Array, options?: any): AxiosPromise; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges1} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser2(userId: string, user: BodyModificationsChanges1, fields?: Array, options?: any): AxiosPromise; }; /** * UsersApi - object-oriented interface * @export * @class UsersApi * @extends {BaseAPI} */ export declare class UsersApi extends BaseAPI { /** * * @param {ApiCreateUserRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ createUser(body: ApiCreateUserRequest, options?: any): Promise>; /** * * @param {string} id ONE /users/{id} * @param {Array} [selection] MANY /users .ids=[id,...] * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteUsers(id: string, selection?: Array, permanent?: boolean, options?: any): Promise>; /** * * @param {Array} selection MANY /users .ids=[id,...] * @param {string} [id] ONE /users/{id} * @param {boolean} [permanent] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteUsers2(selection: Array, id?: string, permanent?: boolean, options?: any): Promise>; /** * * @param {string} id * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ logoutUser(id: string, body: object, options?: any): Promise>; /** * * @param {string} id * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ readUser(id: string, fields?: Array, options?: any): Promise>; /** * * @param {string} [id] * @param {Array} [fields] partial output * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ readUser2(id?: string, fields?: Array, options?: any): Promise>; /** * * @param {Array} [id] ----- Base Filters --------------------------- filter: .id = any({id}...) * @param {Array} [notId] filter: .id <> all({not_ids}...) * @param {string} [q] ----- User-specific Filters ------------------ filter: (.name|.username|.extension|.status) ILIKE \'{q}\' * @param {string} [name] filter: .name ILIKE \'{name}\' * @param {string} [status] filter: .status ILIKE \'{status}\' * @param {string} [username] filter: .username ILIKE \'{username}\' * @param {string} [extension] filter: .extension LIKE \'{extension}\' * @param {boolean} [any] ----- View Modes ----------------------------- NOTE: by default, search NOT \'deleted\' objects ONLY filter: include \'deleted\' ALSO ! (inactive) * @param {boolean} [deleted] filter: .deleted_at NOTNULL (view: RECYCLE) * @param {string} [presenceStatus] * @param {string} [presenceNote] * @param {Array} [fields] // navigation filter repeated int64 roles = 7; ----- Search Options ------------------------- select: output (fields,...) * @param {Array} [sort] select: order by (fields,...) * @param {number} [page] select: offset {page} * @param {number} [size] select: limit {size} * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ searchUsers(id?: Array, notId?: Array, q?: string, name?: string, status?: string, username?: string, extension?: string, any?: boolean, deleted?: boolean, presenceStatus?: string, presenceNote?: string, fields?: Array, sort?: Array, page?: number, size?: number, options?: any): Promise>; /** * * @param {ApiSearchUsersRequest} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ searchUsers2(body: ApiSearchUsersRequest, options?: any): Promise>; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ updateUser(userId: string, user: BodyModificationsChanges, fields?: Array, options?: any): Promise>; /** * * @param {string} userId Object ID * @param {BodyModificationsChanges1} user * @param {Array} [fields] PATCH: partial update * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ updateUser2(userId: string, user: BodyModificationsChanges1, fields?: Array, options?: any): Promise>; } //# sourceMappingURL=users-api.d.ts.map