/** * Cloud API * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) * * 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 { AzureLoginRequestDto } from '../models'; import { AzureMergeRequestDto } from '../models'; import { CreateUserDto } from '../models'; import { EmailVerificationDtoDto } from '../models'; import { FriendDto } from '../models'; import { InvitationsPageDto } from '../models'; import { LoginUserDtoDto } from '../models'; import { MyPermissionDto } from '../models'; import { NewPasswordDtoDto } from '../models'; import { PatchUserDtoDto } from '../models'; import { RegisterUserDtoDto } from '../models'; import { ResetPasswordBodyDto } from '../models'; import { ResetPasswordWithTokenBodyDto } from '../models'; import { ResetPasswordWithTokenResponseDto } from '../models'; import { SearchRequestDto } from '../models'; import { SetPasswordBodyDto } from '../models'; import { UserDto } from '../models'; import { UserEmailDto } from '../models'; import { UserGroupDto } from '../models'; import { UserGroupPageDto } from '../models'; import { UserGroupSearchResultPageDto } from '../models'; import { UserJwtDto } from '../models'; import { UserPageDto } from '../models'; import { UserSearchResultPageDto } from '../models'; /** * UsersApi - axios parameter creator * @export */ export declare const UsersApiAxiosParamCreator: (axiosClientConfiguration?: Configuration) => { /** * Set the user property \'active\' to true. Trigger a workflow event. * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateUser: (id: string, translate?: string, options?: any) => Promise; /** * * @summary Authenticate user with email and password * @param {LoginUserDtoDto} loginUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateUserWithPassword: (loginUserDto: LoginUserDtoDto, translate?: string, options?: any) => Promise; /** * * @summary Update users password * @param {NewPasswordDtoDto} newPasswordDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changePassword: (newPasswordDto: NewPasswordDtoDto, translate?: string, options?: any) => Promise; /** * Verify email confirmation token. * @param {string} token * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmEmail: (token: string, translate?: string, options?: any) => Promise; /** * * @summary Creates (and returns) a new access token for the currently logged in user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAccessToken: (translate?: string, options?: any) => Promise; /** * * @param {CreateUserDto} createUser * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser: (createUser: CreateUserDto, translate?: string, options?: any) => Promise; /** * * @param {UserGroupDto} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUserGroup: (userGroup: UserGroupDto, translate?: string, options?: any) => Promise; /** * Set the user property \'active\' to false and remove the users access tokens. Trigger a workflow event. * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateUser: (id: string, translate?: string, options?: any) => Promise; /** * * @summary Deletes an access token * @param {string} token * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAccessToken: (token: string, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyUserGroups: (ids: Array, translate?: string, options?: any) => Promise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyUsers: (ids: Array, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser: (id: string, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserGroup: (id: string, translate?: string, options?: any) => Promise; /** * * @summary Returns all access tokens for the currently logged in user (not service or login tokens) * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessTokens: (translate?: string, options?: any) => Promise; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyFriends: (translate?: string, options?: any) => Promise; /** * * @param {string} inviteId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyInvitation: (inviteId: string, translate?: string, options?: any) => Promise; /** * Get all information that you\'ve received * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyInvitations: (translate?: string, options?: any) => Promise; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyPermissions: (translate?: string, options?: any) => Promise; /** * * @summary Get my user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUser: (translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser: (id: string, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroup: (id: string, translate?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroups: (page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupsCount: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsers: (page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any) => Promise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsersCount: (page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any) => Promise; /** * * @summary Logs in with a Microsoft Login Token * @param {AzureLoginRequestDto} azureLoginRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginWithMicrosoftToken: (azureLoginRequest: AzureLoginRequestDto, translate?: string, options?: any) => Promise; /** * Afterwards, the current logged in user will (also) be able to login with the given MS AzureAD account. * @summary Merges an already authenticated account with Microsoft Azure AD login * @param {AzureMergeRequestDto} azureMergeRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeAccountWithMicrosoft: (azureMergeRequest: AzureMergeRequestDto, translate?: string, options?: any) => Promise; /** * Updates your own user profile by replacing specific properties. Does not work for arrays. * @param {PatchUserDtoDto} patchUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMyUser: (patchUserDto: PatchUserDtoDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {any} user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchUser: (id: string, user: any, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {any} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchUserGroup: (id: string, userGroup: any, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performUserGroupSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performUserSearch: (searchRequest: SearchRequestDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {UserDto} user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putUser: (id: string, user: UserDto, translate?: string, options?: any) => Promise; /** * * @param {string} id * @param {UserGroupDto} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putUserGroup: (id: string, userGroup: UserGroupDto, translate?: string, options?: any) => Promise; /** * * @summary Register a new user * @param {RegisterUserDtoDto} registerUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerUser: (registerUserDto: RegisterUserDtoDto, translate?: string, options?: any) => Promise; /** * * @summary Removes the personal avatar image * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAvatar: (translate?: string, options?: any) => Promise; /** * * @summary Removes all connected Microsoft Azure AD logins from the account * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMicrosoftLogin: (translate?: string, options?: any) => Promise; /** * Sends a user an email verification link * @param {string} userId * @param {EmailVerificationDtoDto} emailVerificationDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEmailVerification: (userId: string, emailVerificationDto: EmailVerificationDtoDto, translate?: string, options?: any) => Promise; /** * * @summary Sends a password reset mail to the given mail address * @param {ResetPasswordBodyDto} resetPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendResetPasswordMail: (resetPasswordBody: ResetPasswordBodyDto, translate?: string, options?: any) => Promise; /** * * @summary Sends a password reset mail to the given mail address * @param {ResetPasswordBodyDto} resetPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendResetPasswordMailForUser: (resetPasswordBody: ResetPasswordBodyDto, translate?: string, options?: any) => Promise; /** * * @summary Sets the password for the given user * @param {SetPasswordBodyDto} setPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPasswordForUser: (setPasswordBody: SetPasswordBodyDto, translate?: string, options?: any) => Promise; /** * * @summary Updates a password with a reset password token and returns a login token * @param {ResetPasswordWithTokenBodyDto} resetPasswordWithTokenBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPasswordWithResetToken: (resetPasswordWithTokenBody: ResetPasswordWithTokenBodyDto, translate?: string, options?: any) => Promise; /** * Updates your own user profile by replacing the entire profile. * @param {any} profile The own users profile * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMyProfile: (profile: any, translate?: string, options?: any) => Promise; /** * * @summary Returns a signed url where users can upload their avatar image to * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadAvatar: (translate?: string, options?: any) => Promise; /** * This is a very performant method for checking if a User exists. * @summary Check if User exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ userExists: (id: string, options?: any) => Promise; /** * This is a very performant method for checking if a UserGroup exists. * @summary Check if UserGroup exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ userGroupExists: (id: string, options?: any) => Promise; }; /** * UsersApi - functional programming interface * @export */ export declare const UsersApiFp: (axiosClientConfiguration?: Configuration) => { /** * Set the user property \'active\' to true. Trigger a workflow event. * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateUser(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Authenticate user with email and password * @param {LoginUserDtoDto} loginUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateUserWithPassword(loginUserDto: LoginUserDtoDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Update users password * @param {NewPasswordDtoDto} newPasswordDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changePassword(newPasswordDto: NewPasswordDtoDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verify email confirmation token. * @param {string} token * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmEmail(token: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Creates (and returns) a new access token for the currently logged in user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAccessToken(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {CreateUserDto} createUser * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(createUser: CreateUserDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {UserGroupDto} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUserGroup(userGroup: UserGroupDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Set the user property \'active\' to false and remove the users access tokens. Trigger a workflow event. * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateUser(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Deletes an access token * @param {string} token * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAccessToken(token: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyUserGroups(ids: Array, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyUsers(ids: Array, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserGroup(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Returns all access tokens for the currently logged in user (not service or login tokens) * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessTokens(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyFriends(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @param {string} inviteId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyInvitation(inviteId: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all information that you\'ve received * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyInvitations(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyPermissions(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Get my user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUser(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroup(id: string, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroups(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsers(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsersCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Logs in with a Microsoft Login Token * @param {AzureLoginRequestDto} azureLoginRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginWithMicrosoftToken(azureLoginRequest: AzureLoginRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Afterwards, the current logged in user will (also) be able to login with the given MS AzureAD account. * @summary Merges an already authenticated account with Microsoft Azure AD login * @param {AzureMergeRequestDto} azureMergeRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeAccountWithMicrosoft(azureMergeRequest: AzureMergeRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates your own user profile by replacing specific properties. Does not work for arrays. * @param {PatchUserDtoDto} patchUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMyUser(patchUserDto: PatchUserDtoDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {any} user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchUser(id: string, user: any, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {any} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchUserGroup(id: string, userGroup: any, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performUserGroupSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performUserSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {UserDto} user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putUser(id: string, user: UserDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id * @param {UserGroupDto} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putUserGroup(id: string, userGroup: UserGroupDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Register a new user * @param {RegisterUserDtoDto} registerUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerUser(registerUserDto: RegisterUserDtoDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Removes the personal avatar image * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAvatar(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Removes all connected Microsoft Azure AD logins from the account * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMicrosoftLogin(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a user an email verification link * @param {string} userId * @param {EmailVerificationDtoDto} emailVerificationDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEmailVerification(userId: string, emailVerificationDto: EmailVerificationDtoDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Sends a password reset mail to the given mail address * @param {ResetPasswordBodyDto} resetPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendResetPasswordMail(resetPasswordBody: ResetPasswordBodyDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Sends a password reset mail to the given mail address * @param {ResetPasswordBodyDto} resetPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendResetPasswordMailForUser(resetPasswordBody: ResetPasswordBodyDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Sets the password for the given user * @param {SetPasswordBodyDto} setPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPasswordForUser(setPasswordBody: SetPasswordBodyDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Updates a password with a reset password token and returns a login token * @param {ResetPasswordWithTokenBodyDto} resetPasswordWithTokenBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPasswordWithResetToken(resetPasswordWithTokenBody: ResetPasswordWithTokenBodyDto, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates your own user profile by replacing the entire profile. * @param {any} profile The own users profile * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMyProfile(profile: any, translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Returns a signed url where users can upload their avatar image to * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadAvatar(translate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This is a very performant method for checking if a User exists. * @summary Check if User exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ userExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * This is a very performant method for checking if a UserGroup exists. * @summary Check if UserGroup exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ userGroupExists(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * UsersApi - factory interface * @export */ export declare const UsersApiFactory: (axiosClientConfiguration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Set the user property \'active\' to true. Trigger a workflow event. * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ activateUser(id: string, translate?: string, options?: any): AxiosPromise; /** * * @summary Authenticate user with email and password * @param {LoginUserDtoDto} loginUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ authenticateUserWithPassword(loginUserDto: LoginUserDtoDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Update users password * @param {NewPasswordDtoDto} newPasswordDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ changePassword(newPasswordDto: NewPasswordDtoDto, translate?: string, options?: any): AxiosPromise; /** * Verify email confirmation token. * @param {string} token * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ confirmEmail(token: string, translate?: string, options?: any): AxiosPromise; /** * * @summary Creates (and returns) a new access token for the currently logged in user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createAccessToken(translate?: string, options?: any): AxiosPromise; /** * * @param {CreateUserDto} createUser * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUser(createUser: CreateUserDto, translate?: string, options?: any): AxiosPromise; /** * * @param {UserGroupDto} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ createUserGroup(userGroup: UserGroupDto, translate?: string, options?: any): AxiosPromise; /** * Set the user property \'active\' to false and remove the users access tokens. Trigger a workflow event. * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deactivateUser(id: string, translate?: string, options?: any): AxiosPromise; /** * * @summary Deletes an access token * @param {string} token * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAccessToken(token: string, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyUserGroups(ids: Array, translate?: string, options?: any): AxiosPromise; /** * * @param {Array} ids * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteManyUsers(ids: Array, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUser(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteUserGroup(id: string, translate?: string, options?: any): AxiosPromise; /** * * @summary Returns all access tokens for the currently logged in user (not service or login tokens) * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getAccessTokens(translate?: string, options?: any): AxiosPromise>; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyFriends(translate?: string, options?: any): AxiosPromise>; /** * * @param {string} inviteId * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyInvitation(inviteId: string, translate?: string, options?: any): AxiosPromise; /** * Get all information that you\'ve received * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyInvitations(translate?: string, options?: any): AxiosPromise; /** * * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyPermissions(translate?: string, options?: any): AxiosPromise>; /** * * @summary Get my user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMyUser(translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUser(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroup(id: string, translate?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroups(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserGroupsCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [translate] * @param {boolean} [withReplacements] * @param {string} [sort] * @param {string} [search] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsers(page?: number, size?: number, translate?: string, withReplacements?: boolean, sort?: string, search?: string, options?: any): AxiosPromise; /** * * @param {number} [page] * @param {number} [size] * @param {string} [sort] * @param {string} [search] * @param {boolean} [withReplacements] * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUsersCount(page?: number, size?: number, sort?: string, search?: string, withReplacements?: boolean, translate?: string, options?: any): AxiosPromise; /** * * @summary Logs in with a Microsoft Login Token * @param {AzureLoginRequestDto} azureLoginRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginWithMicrosoftToken(azureLoginRequest: AzureLoginRequestDto, translate?: string, options?: any): AxiosPromise; /** * Afterwards, the current logged in user will (also) be able to login with the given MS AzureAD account. * @summary Merges an already authenticated account with Microsoft Azure AD login * @param {AzureMergeRequestDto} azureMergeRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ mergeAccountWithMicrosoft(azureMergeRequest: AzureMergeRequestDto, translate?: string, options?: any): AxiosPromise; /** * Updates your own user profile by replacing specific properties. Does not work for arrays. * @param {PatchUserDtoDto} patchUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMyUser(patchUserDto: PatchUserDtoDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchUser(id: string, user: any, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {any} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchUserGroup(id: string, userGroup: any, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performUserGroupSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {SearchRequestDto} searchRequest * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ performUserSearch(searchRequest: SearchRequestDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {UserDto} user * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putUser(id: string, user: UserDto, translate?: string, options?: any): AxiosPromise; /** * * @param {string} id * @param {UserGroupDto} userGroup * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ putUserGroup(id: string, userGroup: UserGroupDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Register a new user * @param {RegisterUserDtoDto} registerUserDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ registerUser(registerUserDto: RegisterUserDtoDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Removes the personal avatar image * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeAvatar(translate?: string, options?: any): AxiosPromise; /** * * @summary Removes all connected Microsoft Azure AD logins from the account * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeMicrosoftLogin(translate?: string, options?: any): AxiosPromise; /** * Sends a user an email verification link * @param {string} userId * @param {EmailVerificationDtoDto} emailVerificationDto * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEmailVerification(userId: string, emailVerificationDto: EmailVerificationDtoDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Sends a password reset mail to the given mail address * @param {ResetPasswordBodyDto} resetPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendResetPasswordMail(resetPasswordBody: ResetPasswordBodyDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Sends a password reset mail to the given mail address * @param {ResetPasswordBodyDto} resetPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendResetPasswordMailForUser(resetPasswordBody: ResetPasswordBodyDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Sets the password for the given user * @param {SetPasswordBodyDto} setPasswordBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPasswordForUser(setPasswordBody: SetPasswordBodyDto, translate?: string, options?: any): AxiosPromise; /** * * @summary Updates a password with a reset password token and returns a login token * @param {ResetPasswordWithTokenBodyDto} resetPasswordWithTokenBody * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ setPasswordWithResetToken(resetPasswordWithTokenBody: ResetPasswordWithTokenBodyDto, translate?: string, options?: any): AxiosPromise; /** * Updates your own user profile by replacing the entire profile. * @param {any} profile The own users profile * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMyProfile(profile: any, translate?: string, options?: any): AxiosPromise; /** * * @summary Returns a signed url where users can upload their avatar image to * @param {string} [translate] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadAvatar(translate?: string, options?: any): AxiosPromise; /** * This is a very performant method for checking if a User exists. * @summary Check if User exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ userExists(id: string, options?: any): AxiosPromise; /** * This is a very performant method for checking if a UserGroup exists. * @summary Check if UserGroup exists * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} */ userGroupExists(id: string, options?: any): AxiosPromise; }; /** * Request parameters for activateUser operation in UsersApi. * @export * @interface UsersApiActivateUserRequest */ export interface UsersApiActivateUserRequest { /** * * @type {string} * @memberof UsersApiActivateUser */ readonly id: string; /** * * @type {string} * @memberof UsersApiActivateUser */ readonly translate?: string; } /** * Request parameters for authenticateUserWithPassword operation in UsersApi. * @export * @interface UsersApiAuthenticateUserWithPasswordRequest */ export interface UsersApiAuthenticateUserWithPasswordRequest { /** * * @type {LoginUserDtoDto} * @memberof UsersApiAuthenticateUserWithPassword */ readonly loginUserDto: LoginUserDtoDto; /** * * @type {string} * @memberof UsersApiAuthenticateUserWithPassword */ readonly translate?: string; } /** * Request parameters for changePassword operation in UsersApi. * @export * @interface UsersApiChangePasswordRequest */ export interface UsersApiChangePasswordRequest { /** * * @type {NewPasswordDtoDto} * @memberof UsersApiChangePassword */ readonly newPasswordDto: NewPasswordDtoDto; /** * * @type {string} * @memberof UsersApiChangePassword */ readonly translate?: string; } /** * Request parameters for confirmEmail operation in UsersApi. * @export * @interface UsersApiConfirmEmailRequest */ export interface UsersApiConfirmEmailRequest { /** * * @type {string} * @memberof UsersApiConfirmEmail */ readonly token: string; /** * * @type {string} * @memberof UsersApiConfirmEmail */ readonly translate?: string; } /** * Request parameters for createAccessToken operation in UsersApi. * @export * @interface UsersApiCreateAccessTokenRequest */ export interface UsersApiCreateAccessTokenRequest { /** * * @type {string} * @memberof UsersApiCreateAccessToken */ readonly translate?: string; } /** * Request parameters for createUser operation in UsersApi. * @export * @interface UsersApiCreateUserRequest */ export interface UsersApiCreateUserRequest { /** * * @type {CreateUserDto} * @memberof UsersApiCreateUser */ readonly createUser: CreateUserDto; /** * * @type {string} * @memberof UsersApiCreateUser */ readonly translate?: string; } /** * Request parameters for createUserGroup operation in UsersApi. * @export * @interface UsersApiCreateUserGroupRequest */ export interface UsersApiCreateUserGroupRequest { /** * * @type {UserGroupDto} * @memberof UsersApiCreateUserGroup */ readonly userGroup: UserGroupDto; /** * * @type {string} * @memberof UsersApiCreateUserGroup */ readonly translate?: string; } /** * Request parameters for deactivateUser operation in UsersApi. * @export * @interface UsersApiDeactivateUserRequest */ export interface UsersApiDeactivateUserRequest { /** * * @type {string} * @memberof UsersApiDeactivateUser */ readonly id: string; /** * * @type {string} * @memberof UsersApiDeactivateUser */ readonly translate?: string; } /** * Request parameters for deleteAccessToken operation in UsersApi. * @export * @interface UsersApiDeleteAccessTokenRequest */ export interface UsersApiDeleteAccessTokenRequest { /** * * @type {string} * @memberof UsersApiDeleteAccessToken */ readonly token: string; /** * * @type {string} * @memberof UsersApiDeleteAccessToken */ readonly translate?: string; } /** * Request parameters for deleteManyUserGroups operation in UsersApi. * @export * @interface UsersApiDeleteManyUserGroupsRequest */ export interface UsersApiDeleteManyUserGroupsRequest { /** * * @type {Array} * @memberof UsersApiDeleteManyUserGroups */ readonly ids: Array; /** * * @type {string} * @memberof UsersApiDeleteManyUserGroups */ readonly translate?: string; } /** * Request parameters for deleteManyUsers operation in UsersApi. * @export * @interface UsersApiDeleteManyUsersRequest */ export interface UsersApiDeleteManyUsersRequest { /** * * @type {Array} * @memberof UsersApiDeleteManyUsers */ readonly ids: Array; /** * * @type {string} * @memberof UsersApiDeleteManyUsers */ readonly translate?: string; } /** * Request parameters for deleteUser operation in UsersApi. * @export * @interface UsersApiDeleteUserRequest */ export interface UsersApiDeleteUserRequest { /** * * @type {string} * @memberof UsersApiDeleteUser */ readonly id: string; /** * * @type {string} * @memberof UsersApiDeleteUser */ readonly translate?: string; } /** * Request parameters for deleteUserGroup operation in UsersApi. * @export * @interface UsersApiDeleteUserGroupRequest */ export interface UsersApiDeleteUserGroupRequest { /** * * @type {string} * @memberof UsersApiDeleteUserGroup */ readonly id: string; /** * * @type {string} * @memberof UsersApiDeleteUserGroup */ readonly translate?: string; } /** * Request parameters for getAccessTokens operation in UsersApi. * @export * @interface UsersApiGetAccessTokensRequest */ export interface UsersApiGetAccessTokensRequest { /** * * @type {string} * @memberof UsersApiGetAccessTokens */ readonly translate?: string; } /** * Request parameters for getMyFriends operation in UsersApi. * @export * @interface UsersApiGetMyFriendsRequest */ export interface UsersApiGetMyFriendsRequest { /** * * @type {string} * @memberof UsersApiGetMyFriends */ readonly translate?: string; } /** * Request parameters for getMyInvitation operation in UsersApi. * @export * @interface UsersApiGetMyInvitationRequest */ export interface UsersApiGetMyInvitationRequest { /** * * @type {string} * @memberof UsersApiGetMyInvitation */ readonly inviteId: string; /** * * @type {string} * @memberof UsersApiGetMyInvitation */ readonly translate?: string; } /** * Request parameters for getMyInvitations operation in UsersApi. * @export * @interface UsersApiGetMyInvitationsRequest */ export interface UsersApiGetMyInvitationsRequest { /** * * @type {string} * @memberof UsersApiGetMyInvitations */ readonly translate?: string; } /** * Request parameters for getMyPermissions operation in UsersApi. * @export * @interface UsersApiGetMyPermissionsRequest */ export interface UsersApiGetMyPermissionsRequest { /** * * @type {string} * @memberof UsersApiGetMyPermissions */ readonly translate?: string; } /** * Request parameters for getMyUser operation in UsersApi. * @export * @interface UsersApiGetMyUserRequest */ export interface UsersApiGetMyUserRequest { /** * * @type {string} * @memberof UsersApiGetMyUser */ readonly translate?: string; } /** * Request parameters for getUser operation in UsersApi. * @export * @interface UsersApiGetUserRequest */ export interface UsersApiGetUserRequest { /** * * @type {string} * @memberof UsersApiGetUser */ readonly id: string; /** * * @type {string} * @memberof UsersApiGetUser */ readonly translate?: string; } /** * Request parameters for getUserGroup operation in UsersApi. * @export * @interface UsersApiGetUserGroupRequest */ export interface UsersApiGetUserGroupRequest { /** * * @type {string} * @memberof UsersApiGetUserGroup */ readonly id: string; /** * * @type {string} * @memberof UsersApiGetUserGroup */ readonly translate?: string; } /** * Request parameters for getUserGroups operation in UsersApi. * @export * @interface UsersApiGetUserGroupsRequest */ export interface UsersApiGetUserGroupsRequest { /** * * @type {number} * @memberof UsersApiGetUserGroups */ readonly page?: number; /** * * @type {number} * @memberof UsersApiGetUserGroups */ readonly size?: number; /** * * @type {string} * @memberof UsersApiGetUserGroups */ readonly translate?: string; /** * * @type {boolean} * @memberof UsersApiGetUserGroups */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof UsersApiGetUserGroups */ readonly sort?: string; /** * * @type {string} * @memberof UsersApiGetUserGroups */ readonly search?: string; } /** * Request parameters for getUserGroupsCount operation in UsersApi. * @export * @interface UsersApiGetUserGroupsCountRequest */ export interface UsersApiGetUserGroupsCountRequest { /** * * @type {number} * @memberof UsersApiGetUserGroupsCount */ readonly page?: number; /** * * @type {number} * @memberof UsersApiGetUserGroupsCount */ readonly size?: number; /** * * @type {string} * @memberof UsersApiGetUserGroupsCount */ readonly sort?: string; /** * * @type {string} * @memberof UsersApiGetUserGroupsCount */ readonly search?: string; /** * * @type {boolean} * @memberof UsersApiGetUserGroupsCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof UsersApiGetUserGroupsCount */ readonly translate?: string; } /** * Request parameters for getUsers operation in UsersApi. * @export * @interface UsersApiGetUsersRequest */ export interface UsersApiGetUsersRequest { /** * * @type {number} * @memberof UsersApiGetUsers */ readonly page?: number; /** * * @type {number} * @memberof UsersApiGetUsers */ readonly size?: number; /** * * @type {string} * @memberof UsersApiGetUsers */ readonly translate?: string; /** * * @type {boolean} * @memberof UsersApiGetUsers */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof UsersApiGetUsers */ readonly sort?: string; /** * * @type {string} * @memberof UsersApiGetUsers */ readonly search?: string; } /** * Request parameters for getUsersCount operation in UsersApi. * @export * @interface UsersApiGetUsersCountRequest */ export interface UsersApiGetUsersCountRequest { /** * * @type {number} * @memberof UsersApiGetUsersCount */ readonly page?: number; /** * * @type {number} * @memberof UsersApiGetUsersCount */ readonly size?: number; /** * * @type {string} * @memberof UsersApiGetUsersCount */ readonly sort?: string; /** * * @type {string} * @memberof UsersApiGetUsersCount */ readonly search?: string; /** * * @type {boolean} * @memberof UsersApiGetUsersCount */ readonly withReplacements?: boolean; /** * * @type {string} * @memberof UsersApiGetUsersCount */ readonly translate?: string; } /** * Request parameters for loginWithMicrosoftToken operation in UsersApi. * @export * @interface UsersApiLoginWithMicrosoftTokenRequest */ export interface UsersApiLoginWithMicrosoftTokenRequest { /** * * @type {AzureLoginRequestDto} * @memberof UsersApiLoginWithMicrosoftToken */ readonly azureLoginRequest: AzureLoginRequestDto; /** * * @type {string} * @memberof UsersApiLoginWithMicrosoftToken */ readonly translate?: string; } /** * Request parameters for mergeAccountWithMicrosoft operation in UsersApi. * @export * @interface UsersApiMergeAccountWithMicrosoftRequest */ export interface UsersApiMergeAccountWithMicrosoftRequest { /** * * @type {AzureMergeRequestDto} * @memberof UsersApiMergeAccountWithMicrosoft */ readonly azureMergeRequest: AzureMergeRequestDto; /** * * @type {string} * @memberof UsersApiMergeAccountWithMicrosoft */ readonly translate?: string; } /** * Request parameters for patchMyUser operation in UsersApi. * @export * @interface UsersApiPatchMyUserRequest */ export interface UsersApiPatchMyUserRequest { /** * * @type {PatchUserDtoDto} * @memberof UsersApiPatchMyUser */ readonly patchUserDto: PatchUserDtoDto; /** * * @type {string} * @memberof UsersApiPatchMyUser */ readonly translate?: string; } /** * Request parameters for patchUser operation in UsersApi. * @export * @interface UsersApiPatchUserRequest */ export interface UsersApiPatchUserRequest { /** * * @type {string} * @memberof UsersApiPatchUser */ readonly id: string; /** * * @type {any} * @memberof UsersApiPatchUser */ readonly user: any; /** * * @type {string} * @memberof UsersApiPatchUser */ readonly translate?: string; } /** * Request parameters for patchUserGroup operation in UsersApi. * @export * @interface UsersApiPatchUserGroupRequest */ export interface UsersApiPatchUserGroupRequest { /** * * @type {string} * @memberof UsersApiPatchUserGroup */ readonly id: string; /** * * @type {any} * @memberof UsersApiPatchUserGroup */ readonly userGroup: any; /** * * @type {string} * @memberof UsersApiPatchUserGroup */ readonly translate?: string; } /** * Request parameters for performUserGroupSearch operation in UsersApi. * @export * @interface UsersApiPerformUserGroupSearchRequest */ export interface UsersApiPerformUserGroupSearchRequest { /** * * @type {SearchRequestDto} * @memberof UsersApiPerformUserGroupSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof UsersApiPerformUserGroupSearch */ readonly translate?: string; } /** * Request parameters for performUserSearch operation in UsersApi. * @export * @interface UsersApiPerformUserSearchRequest */ export interface UsersApiPerformUserSearchRequest { /** * * @type {SearchRequestDto} * @memberof UsersApiPerformUserSearch */ readonly searchRequest: SearchRequestDto; /** * * @type {string} * @memberof UsersApiPerformUserSearch */ readonly translate?: string; } /** * Request parameters for putUser operation in UsersApi. * @export * @interface UsersApiPutUserRequest */ export interface UsersApiPutUserRequest { /** * * @type {string} * @memberof UsersApiPutUser */ readonly id: string; /** * * @type {UserDto} * @memberof UsersApiPutUser */ readonly user: UserDto; /** * * @type {string} * @memberof UsersApiPutUser */ readonly translate?: string; } /** * Request parameters for putUserGroup operation in UsersApi. * @export * @interface UsersApiPutUserGroupRequest */ export interface UsersApiPutUserGroupRequest { /** * * @type {string} * @memberof UsersApiPutUserGroup */ readonly id: string; /** * * @type {UserGroupDto} * @memberof UsersApiPutUserGroup */ readonly userGroup: UserGroupDto; /** * * @type {string} * @memberof UsersApiPutUserGroup */ readonly translate?: string; } /** * Request parameters for registerUser operation in UsersApi. * @export * @interface UsersApiRegisterUserRequest */ export interface UsersApiRegisterUserRequest { /** * * @type {RegisterUserDtoDto} * @memberof UsersApiRegisterUser */ readonly registerUserDto: RegisterUserDtoDto; /** * * @type {string} * @memberof UsersApiRegisterUser */ readonly translate?: string; } /** * Request parameters for removeAvatar operation in UsersApi. * @export * @interface UsersApiRemoveAvatarRequest */ export interface UsersApiRemoveAvatarRequest { /** * * @type {string} * @memberof UsersApiRemoveAvatar */ readonly translate?: string; } /** * Request parameters for removeMicrosoftLogin operation in UsersApi. * @export * @interface UsersApiRemoveMicrosoftLoginRequest */ export interface UsersApiRemoveMicrosoftLoginRequest { /** * * @type {string} * @memberof UsersApiRemoveMicrosoftLogin */ readonly translate?: string; } /** * Request parameters for sendEmailVerification operation in UsersApi. * @export * @interface UsersApiSendEmailVerificationRequest */ export interface UsersApiSendEmailVerificationRequest { /** * * @type {string} * @memberof UsersApiSendEmailVerification */ readonly userId: string; /** * * @type {EmailVerificationDtoDto} * @memberof UsersApiSendEmailVerification */ readonly emailVerificationDto: EmailVerificationDtoDto; /** * * @type {string} * @memberof UsersApiSendEmailVerification */ readonly translate?: string; } /** * Request parameters for sendResetPasswordMail operation in UsersApi. * @export * @interface UsersApiSendResetPasswordMailRequest */ export interface UsersApiSendResetPasswordMailRequest { /** * * @type {ResetPasswordBodyDto} * @memberof UsersApiSendResetPasswordMail */ readonly resetPasswordBody: ResetPasswordBodyDto; /** * * @type {string} * @memberof UsersApiSendResetPasswordMail */ readonly translate?: string; } /** * Request parameters for sendResetPasswordMailForUser operation in UsersApi. * @export * @interface UsersApiSendResetPasswordMailForUserRequest */ export interface UsersApiSendResetPasswordMailForUserRequest { /** * * @type {ResetPasswordBodyDto} * @memberof UsersApiSendResetPasswordMailForUser */ readonly resetPasswordBody: ResetPasswordBodyDto; /** * * @type {string} * @memberof UsersApiSendResetPasswordMailForUser */ readonly translate?: string; } /** * Request parameters for setPasswordForUser operation in UsersApi. * @export * @interface UsersApiSetPasswordForUserRequest */ export interface UsersApiSetPasswordForUserRequest { /** * * @type {SetPasswordBodyDto} * @memberof UsersApiSetPasswordForUser */ readonly setPasswordBody: SetPasswordBodyDto; /** * * @type {string} * @memberof UsersApiSetPasswordForUser */ readonly translate?: string; } /** * Request parameters for setPasswordWithResetToken operation in UsersApi. * @export * @interface UsersApiSetPasswordWithResetTokenRequest */ export interface UsersApiSetPasswordWithResetTokenRequest { /** * * @type {ResetPasswordWithTokenBodyDto} * @memberof UsersApiSetPasswordWithResetToken */ readonly resetPasswordWithTokenBody: ResetPasswordWithTokenBodyDto; /** * * @type {string} * @memberof UsersApiSetPasswordWithResetToken */ readonly translate?: string; } /** * Request parameters for updateMyProfile operation in UsersApi. * @export * @interface UsersApiUpdateMyProfileRequest */ export interface UsersApiUpdateMyProfileRequest { /** * The own users profile * @type {any} * @memberof UsersApiUpdateMyProfile */ readonly profile: any; /** * * @type {string} * @memberof UsersApiUpdateMyProfile */ readonly translate?: string; } /** * Request parameters for uploadAvatar operation in UsersApi. * @export * @interface UsersApiUploadAvatarRequest */ export interface UsersApiUploadAvatarRequest { /** * * @type {string} * @memberof UsersApiUploadAvatar */ readonly translate?: string; } /** * Request parameters for userExists operation in UsersApi. * @export * @interface UsersApiUserExistsRequest */ export interface UsersApiUserExistsRequest { /** * * @type {string} * @memberof UsersApiUserExists */ readonly id: string; } /** * Request parameters for userGroupExists operation in UsersApi. * @export * @interface UsersApiUserGroupExistsRequest */ export interface UsersApiUserGroupExistsRequest { /** * * @type {string} * @memberof UsersApiUserGroupExists */ readonly id: string; } /** * UsersApi - object-oriented interface * @export * @class UsersApi * @extends {BaseAPI} */ export declare class UsersApi extends BaseAPI { /** * Set the user property \'active\' to true. Trigger a workflow event. * @param {UsersApiActivateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ activateUser(requestParameters: UsersApiActivateUserRequest, options?: any): Promise>; /** * * @summary Authenticate user with email and password * @param {UsersApiAuthenticateUserWithPasswordRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ authenticateUserWithPassword(requestParameters: UsersApiAuthenticateUserWithPasswordRequest, options?: any): Promise>; /** * * @summary Update users password * @param {UsersApiChangePasswordRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ changePassword(requestParameters: UsersApiChangePasswordRequest, options?: any): Promise>; /** * Verify email confirmation token. * @param {UsersApiConfirmEmailRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ confirmEmail(requestParameters: UsersApiConfirmEmailRequest, options?: any): Promise>; /** * * @summary Creates (and returns) a new access token for the currently logged in user * @param {UsersApiCreateAccessTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ createAccessToken(requestParameters?: UsersApiCreateAccessTokenRequest, options?: any): Promise>; /** * * @param {UsersApiCreateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ createUser(requestParameters: UsersApiCreateUserRequest, options?: any): Promise>; /** * * @param {UsersApiCreateUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ createUserGroup(requestParameters: UsersApiCreateUserGroupRequest, options?: any): Promise>; /** * Set the user property \'active\' to false and remove the users access tokens. Trigger a workflow event. * @param {UsersApiDeactivateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deactivateUser(requestParameters: UsersApiDeactivateUserRequest, options?: any): Promise>; /** * * @summary Deletes an access token * @param {UsersApiDeleteAccessTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteAccessToken(requestParameters: UsersApiDeleteAccessTokenRequest, options?: any): Promise>; /** * * @param {UsersApiDeleteManyUserGroupsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteManyUserGroups(requestParameters: UsersApiDeleteManyUserGroupsRequest, options?: any): Promise>; /** * * @param {UsersApiDeleteManyUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteManyUsers(requestParameters: UsersApiDeleteManyUsersRequest, options?: any): Promise>; /** * * @param {UsersApiDeleteUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteUser(requestParameters: UsersApiDeleteUserRequest, options?: any): Promise>; /** * * @param {UsersApiDeleteUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ deleteUserGroup(requestParameters: UsersApiDeleteUserGroupRequest, options?: any): Promise>; /** * * @summary Returns all access tokens for the currently logged in user (not service or login tokens) * @param {UsersApiGetAccessTokensRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getAccessTokens(requestParameters?: UsersApiGetAccessTokensRequest, options?: any): Promise>; /** * * @param {UsersApiGetMyFriendsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getMyFriends(requestParameters?: UsersApiGetMyFriendsRequest, options?: any): Promise>; /** * * @param {UsersApiGetMyInvitationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getMyInvitation(requestParameters: UsersApiGetMyInvitationRequest, options?: any): Promise>; /** * Get all information that you\'ve received * @param {UsersApiGetMyInvitationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getMyInvitations(requestParameters?: UsersApiGetMyInvitationsRequest, options?: any): Promise>; /** * * @param {UsersApiGetMyPermissionsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getMyPermissions(requestParameters?: UsersApiGetMyPermissionsRequest, options?: any): Promise>; /** * * @summary Get my user * @param {UsersApiGetMyUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getMyUser(requestParameters?: UsersApiGetMyUserRequest, options?: any): Promise>; /** * * @param {UsersApiGetUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getUser(requestParameters: UsersApiGetUserRequest, options?: any): Promise>; /** * * @param {UsersApiGetUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getUserGroup(requestParameters: UsersApiGetUserGroupRequest, options?: any): Promise>; /** * * @param {UsersApiGetUserGroupsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getUserGroups(requestParameters?: UsersApiGetUserGroupsRequest, options?: any): Promise>; /** * * @param {UsersApiGetUserGroupsCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getUserGroupsCount(requestParameters?: UsersApiGetUserGroupsCountRequest, options?: any): Promise>; /** * * @param {UsersApiGetUsersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getUsers(requestParameters?: UsersApiGetUsersRequest, options?: any): Promise>; /** * * @param {UsersApiGetUsersCountRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ getUsersCount(requestParameters?: UsersApiGetUsersCountRequest, options?: any): Promise>; /** * * @summary Logs in with a Microsoft Login Token * @param {UsersApiLoginWithMicrosoftTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ loginWithMicrosoftToken(requestParameters: UsersApiLoginWithMicrosoftTokenRequest, options?: any): Promise>; /** * Afterwards, the current logged in user will (also) be able to login with the given MS AzureAD account. * @summary Merges an already authenticated account with Microsoft Azure AD login * @param {UsersApiMergeAccountWithMicrosoftRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ mergeAccountWithMicrosoft(requestParameters: UsersApiMergeAccountWithMicrosoftRequest, options?: any): Promise>; /** * Updates your own user profile by replacing specific properties. Does not work for arrays. * @param {UsersApiPatchMyUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ patchMyUser(requestParameters: UsersApiPatchMyUserRequest, options?: any): Promise>; /** * * @param {UsersApiPatchUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ patchUser(requestParameters: UsersApiPatchUserRequest, options?: any): Promise>; /** * * @param {UsersApiPatchUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ patchUserGroup(requestParameters: UsersApiPatchUserGroupRequest, options?: any): Promise>; /** * * @param {UsersApiPerformUserGroupSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ performUserGroupSearch(requestParameters: UsersApiPerformUserGroupSearchRequest, options?: any): Promise>; /** * * @param {UsersApiPerformUserSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ performUserSearch(requestParameters: UsersApiPerformUserSearchRequest, options?: any): Promise>; /** * * @param {UsersApiPutUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ putUser(requestParameters: UsersApiPutUserRequest, options?: any): Promise>; /** * * @param {UsersApiPutUserGroupRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ putUserGroup(requestParameters: UsersApiPutUserGroupRequest, options?: any): Promise>; /** * * @summary Register a new user * @param {UsersApiRegisterUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ registerUser(requestParameters: UsersApiRegisterUserRequest, options?: any): Promise>; /** * * @summary Removes the personal avatar image * @param {UsersApiRemoveAvatarRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ removeAvatar(requestParameters?: UsersApiRemoveAvatarRequest, options?: any): Promise>; /** * * @summary Removes all connected Microsoft Azure AD logins from the account * @param {UsersApiRemoveMicrosoftLoginRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ removeMicrosoftLogin(requestParameters?: UsersApiRemoveMicrosoftLoginRequest, options?: any): Promise>; /** * Sends a user an email verification link * @param {UsersApiSendEmailVerificationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ sendEmailVerification(requestParameters: UsersApiSendEmailVerificationRequest, options?: any): Promise>; /** * * @summary Sends a password reset mail to the given mail address * @param {UsersApiSendResetPasswordMailRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ sendResetPasswordMail(requestParameters: UsersApiSendResetPasswordMailRequest, options?: any): Promise>; /** * * @summary Sends a password reset mail to the given mail address * @param {UsersApiSendResetPasswordMailForUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ sendResetPasswordMailForUser(requestParameters: UsersApiSendResetPasswordMailForUserRequest, options?: any): Promise>; /** * * @summary Sets the password for the given user * @param {UsersApiSetPasswordForUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ setPasswordForUser(requestParameters: UsersApiSetPasswordForUserRequest, options?: any): Promise>; /** * * @summary Updates a password with a reset password token and returns a login token * @param {UsersApiSetPasswordWithResetTokenRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ setPasswordWithResetToken(requestParameters: UsersApiSetPasswordWithResetTokenRequest, options?: any): Promise>; /** * Updates your own user profile by replacing the entire profile. * @param {UsersApiUpdateMyProfileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ updateMyProfile(requestParameters: UsersApiUpdateMyProfileRequest, options?: any): Promise>; /** * * @summary Returns a signed url where users can upload their avatar image to * @param {UsersApiUploadAvatarRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ uploadAvatar(requestParameters?: UsersApiUploadAvatarRequest, options?: any): Promise>; /** * This is a very performant method for checking if a User exists. * @summary Check if User exists * @param {UsersApiUserExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ userExists(requestParameters: UsersApiUserExistsRequest, options?: any): Promise>; /** * This is a very performant method for checking if a UserGroup exists. * @summary Check if UserGroup exists * @param {UsersApiUserGroupExistsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UsersApi */ userGroupExists(requestParameters: UsersApiUserGroupExistsRequest, options?: any): Promise>; }