/* eslint-disable @typescript-eslint/no-explicit-any */ /** * Generated by orval 🍺 * Do not edit manually. * API * API documentation for the starter-kit project in NestJS by BinarApps. The API allows management of users, sessions and offers various functions for logged in users. Contains examples of authentication, authorization, and CRUD for selected resources. * OpenAPI spec version: 1.0 */ import { useMutation, useQuery } from '@tanstack/react-query' import type { DataTag, DefinedInitialDataOptions, DefinedUseQueryResult, MutationFunction, QueryFunction, QueryKey, UndefinedInitialDataOptions, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult, } from '@tanstack/react-query' import { customInstance } from '../../axios/custom-instance' import type { ErrorType, BodyType } from '../../axios/custom-instance' import type { AuthConfirmEmailChangeDto, AuthConfirmEmailDto, AuthEmailChangeDto, AuthEmailLoginDto, AuthEntity, AuthForgotPasswordDto, AuthRegisterLoginDto, AuthResendVerificationEmailDto, AuthResetPasswordDto, AuthUpdateDto, ErrorEntity, ErrorServerEntity, ErrorTooManyRequestsEntity, ErrorUnauthorizedEntity, ErrorValidationEntity, RefreshEntity, UserEntity, } from '../../types' type SecondParameter any> = Parameters[1] /** * Logs the user into the system and returns access tokens * @summary User Login */ export const authControllerLogin = ( authEmailLoginDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/email/login`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authEmailLoginDto, signal, }, options ) } export const getAuthControllerLoginMutationOptions = < TData = Awaited>, TError = ErrorType< | ErrorUnauthorizedEntity | ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }) => { const mutationKey = ['authControllerLogin'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerLogin(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerLoginMutationResult = NonNullable< Awaited> > export type AuthControllerLoginMutationBody = BodyType export type AuthControllerLoginMutationError = ErrorType< | ErrorUnauthorizedEntity | ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary User Login */ export const useAuthControllerLogin = < TData = Awaited>, TError = ErrorType< | ErrorUnauthorizedEntity | ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerLoginMutationOptions(options) return useMutation(mutationOptions) } /** * Registers a new user with email and password * @summary User Registration */ export const authControllerRegister = ( authRegisterLoginDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/email/register`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authRegisterLoginDto, signal, }, options ) } export const getAuthControllerRegisterMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }) => { const mutationKey = ['authControllerRegister'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerRegister(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerRegisterMutationResult = NonNullable< Awaited> > export type AuthControllerRegisterMutationBody = BodyType export type AuthControllerRegisterMutationError = ErrorType< void | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary User Registration */ export const useAuthControllerRegister = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerRegisterMutationOptions(options) return useMutation(mutationOptions) } /** * Confirms the user's email address using the provided confirmation hash. * @summary Confirm Email */ export const authControllerConfirmEmail = ( authConfirmEmailDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/email/confirm`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authConfirmEmailDto, signal, }, options ) } export const getAuthControllerConfirmEmailMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }) => { const mutationKey = ['authControllerConfirmEmail'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerConfirmEmail(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerConfirmEmailMutationResult = NonNullable< Awaited> > export type AuthControllerConfirmEmailMutationBody = BodyType export type AuthControllerConfirmEmailMutationError = ErrorType< void | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary Confirm Email */ export const useAuthControllerConfirmEmail = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerConfirmEmailMutationOptions(options) return useMutation(mutationOptions) } /** * Resend the verification email to the user's email address. * @summary Resend Verification Email */ export const authControllerResendVerificationEmail = ( authResendVerificationEmailDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/email/resend`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authResendVerificationEmailDto, signal, }, options ) } export const getAuthControllerResendVerificationEmailMutationOptions = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions< TData, TError, { data: BodyType }, TContext > request?: SecondParameter }) => { const mutationKey = ['authControllerResendVerificationEmail'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerResendVerificationEmail(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerResendVerificationEmailMutationResult = NonNullable< Awaited> > export type AuthControllerResendVerificationEmailMutationBody = BodyType export type AuthControllerResendVerificationEmailMutationError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary Resend Verification Email */ export const useAuthControllerResendVerificationEmail = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions< TData, TError, { data: BodyType }, TContext > request?: SecondParameter }): UseMutationResult< TData, TError, { data: BodyType }, TContext > => { const mutationOptions = getAuthControllerResendVerificationEmailMutationOptions(options) return useMutation(mutationOptions) } /** * Initiates the password reset process by sending an email with a reset link to the user's email address. * @summary Forgot Password */ export const authControllerForgotPassword = ( authForgotPasswordDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/forgot/password`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authForgotPasswordDto, signal, }, options ) } export const getAuthControllerForgotPasswordMutationOptions = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }) => { const mutationKey = ['authControllerForgotPassword'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerForgotPassword(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerForgotPasswordMutationResult = NonNullable< Awaited> > export type AuthControllerForgotPasswordMutationBody = BodyType export type AuthControllerForgotPasswordMutationError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary Forgot Password */ export const useAuthControllerForgotPassword = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerForgotPasswordMutationOptions(options) return useMutation(mutationOptions) } /** * Resets the user's password using the provided reset password hash. * @summary Reset Password */ export const authControllerResetPassword = ( authResetPasswordDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/reset/password`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authResetPasswordDto, signal, }, options ) } export const getAuthControllerResetPasswordMutationOptions = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }) => { const mutationKey = ['authControllerResetPassword'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerResetPassword(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerResetPasswordMutationResult = NonNullable< Awaited> > export type AuthControllerResetPasswordMutationBody = BodyType export type AuthControllerResetPasswordMutationError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary Reset Password */ export const useAuthControllerResetPassword = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerResetPasswordMutationOptions(options) return useMutation(mutationOptions) } /** * Initiates the process to change the user's email address. After initialization, the user must confirm the email address change through another endpoint. * @summary Initialize Email Change */ export const authControllerEmailChange = ( authEmailChangeDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/email/change`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authEmailChangeDto, signal, }, options ) } export const getAuthControllerEmailChangeMutationOptions = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }) => { const mutationKey = ['authControllerEmailChange'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerEmailChange(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerEmailChangeMutationResult = NonNullable< Awaited> > export type AuthControllerEmailChangeMutationBody = BodyType export type AuthControllerEmailChangeMutationError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary Initialize Email Change */ export const useAuthControllerEmailChange = < TData = Awaited>, TError = ErrorType< ErrorEntity | ErrorValidationEntity | ErrorTooManyRequestsEntity | ErrorServerEntity >, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerEmailChangeMutationOptions(options) return useMutation(mutationOptions) } /** * Confirms the change of a user's email address using a verification code sent to the new email. This endpoint validates the verification code (hash) received by the user to complete the email address change process. * @summary Confirm Email Change */ export const authControllerConfirmEmailChange = ( authConfirmEmailChangeDto: BodyType, options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/email/change-confirm`, method: 'POST', headers: { 'Content-Type': 'application/json' }, data: authConfirmEmailChangeDto, signal, }, options ) } export const getAuthControllerConfirmEmailChangeMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions< TData, TError, { data: BodyType }, TContext > request?: SecondParameter }) => { const mutationKey = ['authControllerConfirmEmailChange'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerConfirmEmailChange(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerConfirmEmailChangeMutationResult = NonNullable< Awaited> > export type AuthControllerConfirmEmailChangeMutationBody = BodyType export type AuthControllerConfirmEmailChangeMutationError = ErrorType< ErrorEntity | ErrorTooManyRequestsEntity | ErrorServerEntity > /** * @summary Confirm Email Change */ export const useAuthControllerConfirmEmailChange = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions< TData, TError, { data: BodyType }, TContext > request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerConfirmEmailChangeMutationOptions(options) return useMutation(mutationOptions) } /** * Retrieves information about the current authenticated user * @summary Get Current User */ export const authControllerMe = ( options?: SecondParameter, signal?: AbortSignal ) => { return customInstance({ url: `/api/v1/auth/me`, method: 'GET', signal }, options) } export const getAuthControllerMeQueryKey = () => { return [`/api/v1/auth/me`] as const } export const getAuthControllerMeQueryOptions = < TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial>, TError, TData>> request?: SecondParameter }) => { const { query: queryOptions, request: requestOptions } = options ?? {} const queryKey = queryOptions?.queryKey ?? getAuthControllerMeQueryKey() const queryFn: QueryFunction>> = ({ signal }) => authControllerMe(requestOptions, signal) return { queryKey, queryFn, ...queryOptions } as UseQueryOptions< Awaited>, TError, TData > & { queryKey: DataTag } } export type AuthControllerMeQueryResult = NonNullable>> export type AuthControllerMeQueryError = ErrorType export function useAuthControllerMe< TData = Awaited>, TError = ErrorType, >(options: { query: Partial>, TError, TData>> & Pick< DefinedInitialDataOptions>, TError, TData>, 'initialData' > request?: SecondParameter }): DefinedUseQueryResult & { queryKey: DataTag } export function useAuthControllerMe< TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial>, TError, TData>> & Pick< UndefinedInitialDataOptions>, TError, TData>, 'initialData' > request?: SecondParameter }): UseQueryResult & { queryKey: DataTag } export function useAuthControllerMe< TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial>, TError, TData>> request?: SecondParameter }): UseQueryResult & { queryKey: DataTag } /** * @summary Get Current User */ export function useAuthControllerMe< TData = Awaited>, TError = ErrorType, >(options?: { query?: Partial>, TError, TData>> request?: SecondParameter }): UseQueryResult & { queryKey: DataTag } { const queryOptions = getAuthControllerMeQueryOptions(options) const query = useQuery(queryOptions) as UseQueryResult & { queryKey: DataTag } query.queryKey = queryOptions.queryKey return query } /** * Updates information about the current authenticated user * @summary Update Current User */ export const authControllerUpdate = ( authUpdateDto: BodyType, options?: SecondParameter ) => { return customInstance( { url: `/api/v1/auth/me`, method: 'PATCH', headers: { 'Content-Type': 'application/json' }, data: authUpdateDto, }, options ) } export const getAuthControllerUpdateMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }) => { const mutationKey = ['authControllerUpdate'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, { data: BodyType } > = (props) => { const { data } = props ?? {} return authControllerUpdate(data, requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions< TData, TError, { data: BodyType }, TContext > } export type AuthControllerUpdateMutationResult = NonNullable< Awaited> > export type AuthControllerUpdateMutationBody = BodyType export type AuthControllerUpdateMutationError = ErrorType< ErrorUnauthorizedEntity | void | ErrorEntity | ErrorServerEntity > /** * @summary Update Current User */ export const useAuthControllerUpdate = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions }, TContext> request?: SecondParameter }): UseMutationResult }, TContext> => { const mutationOptions = getAuthControllerUpdateMutationOptions(options) return useMutation(mutationOptions) } /** * Deletes the current authenticated user * @summary Delete Current User */ export const authControllerDelete = (options?: SecondParameter) => { return customInstance({ url: `/api/v1/auth/me`, method: 'DELETE' }, options) } export const getAuthControllerDeleteMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }) => { const mutationKey = ['authControllerDelete'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, void > = () => { return authControllerDelete(requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions } export type AuthControllerDeleteMutationResult = NonNullable< Awaited> > export type AuthControllerDeleteMutationError = ErrorType< ErrorUnauthorizedEntity | ErrorServerEntity > /** * @summary Delete Current User */ export const useAuthControllerDelete = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }): UseMutationResult => { const mutationOptions = getAuthControllerDeleteMutationOptions(options) return useMutation(mutationOptions) } /** * Refreshes the access token using the refresh token * @summary Refresh Access Token */ export const authControllerRefresh = ( options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/refresh`, method: 'POST', signal }, options ) } export const getAuthControllerRefreshMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }) => { const mutationKey = ['authControllerRefresh'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, void > = () => { return authControllerRefresh(requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions } export type AuthControllerRefreshMutationResult = NonNullable< Awaited> > export type AuthControllerRefreshMutationError = ErrorType< ErrorUnauthorizedEntity | ErrorServerEntity > /** * @summary Refresh Access Token */ export const useAuthControllerRefresh = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }): UseMutationResult => { const mutationOptions = getAuthControllerRefreshMutationOptions(options) return useMutation(mutationOptions) } /** * Logs the user out of the system * @summary Logout */ export const authControllerLogout = ( options?: SecondParameter, signal?: AbortSignal ) => { return customInstance({ url: `/api/v1/auth/logout`, method: 'POST', signal }, options) } export const getAuthControllerLogoutMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }) => { const mutationKey = ['authControllerLogout'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, void > = () => { return authControllerLogout(requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions } export type AuthControllerLogoutMutationResult = NonNullable< Awaited> > export type AuthControllerLogoutMutationError = ErrorType< ErrorUnauthorizedEntity | ErrorServerEntity > /** * @summary Logout */ export const useAuthControllerLogout = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }): UseMutationResult => { const mutationOptions = getAuthControllerLogoutMutationOptions(options) return useMutation(mutationOptions) } /** * Logs the user out of all active sessions to enhance security in case of unauthorized access or when changing sensitive account information like passwords * @summary Logout all sessions */ export const authControllerLogoutAll = ( options?: SecondParameter, signal?: AbortSignal ) => { return customInstance( { url: `/api/v1/auth/logout/all`, method: 'POST', signal }, options ) } export const getAuthControllerLogoutAllMutationOptions = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }) => { const mutationKey = ['authControllerLogoutAll'] const { mutation: mutationOptions, request: requestOptions } = options ? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey ? options : { ...options, mutation: { ...options.mutation, mutationKey } } : { mutation: { mutationKey }, request: undefined } const mutationFn: MutationFunction< Awaited>, void > = () => { return authControllerLogoutAll(requestOptions) } return { mutationFn, ...mutationOptions } as UseMutationOptions } export type AuthControllerLogoutAllMutationResult = NonNullable< Awaited> > export type AuthControllerLogoutAllMutationError = ErrorType< ErrorUnauthorizedEntity | ErrorServerEntity > /** * @summary Logout all sessions */ export const useAuthControllerLogoutAll = < TData = Awaited>, TError = ErrorType, TContext = unknown, >(options?: { mutation?: UseMutationOptions request?: SecondParameter }): UseMutationResult => { const mutationOptions = getAuthControllerLogoutAllMutationOptions(options) return useMutation(mutationOptions) }