helixzypher-api-client/dist/api/generated/helixz-user-resource/helixz-user-resource.d.ts

Orval generated API client for heliZypher

import type { DataTag, DefinedInitialDataOptions, DefinedUseQueryResult, QueryClient, QueryKey, UndefinedInitialDataOptions, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from "@tanstack/react-query";
import type { AxiosError, AxiosRequestConfig, AxiosResponse } from "axios";
import type { ListResponseWrapperUserSuggestion, PagingListResponseWrapperUser, RetrieveUserForSuggestionsParams, SearchUsersParams, SimpleResponseWrapperDeleteResponse, SimpleResponseWrapperUser, Tsid, UserCreateDto, UserUpdateDto } from "../../model";
/**
 * This function fetches a specific user by the Id
 */
export declare const getUserByID: (userId: Tsid, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperUser>>;
export declare const getGetUserByIDQueryKey: (userId: Tsid) => readonly [`/api/helixzypher/v1/users/${string}`];
export declare const getGetUserByIDQueryOptions: <TData = Awaited<ReturnType<typeof getUserByID>>, TError = AxiosError<SimpleResponseWrapperUser>>(userId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserByID>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getUserByID>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type GetUserByIDQueryResult = NonNullable<Awaited<ReturnType<typeof getUserByID>>>;
export type GetUserByIDQueryError = AxiosError<SimpleResponseWrapperUser>;
export declare function useGetUserByID<TData = Awaited<ReturnType<typeof getUserByID>>, TError = AxiosError<SimpleResponseWrapperUser>>(userId: Tsid, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserByID>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getUserByID>>, TError, Awaited<ReturnType<typeof getUserByID>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useGetUserByID<TData = Awaited<ReturnType<typeof getUserByID>>, TError = AxiosError<SimpleResponseWrapperUser>>(userId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserByID>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getUserByID>>, TError, Awaited<ReturnType<typeof getUserByID>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useGetUserByID<TData = Awaited<ReturnType<typeof getUserByID>>, TError = AxiosError<SimpleResponseWrapperUser>>(userId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUserByID>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
/**
 * Update an existing User using given details
 */
export declare const updateUserStatus: (userId: Tsid, userUpdateDto: UserUpdateDto, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperUser>>;
export declare const getUpdateUserStatusMutationOptions: <TError = AxiosError<SimpleResponseWrapperUser>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateUserStatus>>, TError, {
        userId: Tsid;
        data: UserUpdateDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof updateUserStatus>>, TError, {
    userId: Tsid;
    data: UserUpdateDto;
}, TContext>;
export type UpdateUserStatusMutationResult = NonNullable<Awaited<ReturnType<typeof updateUserStatus>>>;
export type UpdateUserStatusMutationBody = UserUpdateDto;
export type UpdateUserStatusMutationError = AxiosError<SimpleResponseWrapperUser>;
export declare const useUpdateUserStatus: <TError = AxiosError<SimpleResponseWrapperUser>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateUserStatus>>, TError, {
        userId: Tsid;
        data: UserUpdateDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updateUserStatus>>, TError, {
    userId: Tsid;
    data: UserUpdateDto;
}, TContext>;
/**
 * Delete User ID by given user id
 */
export declare const deleteUserById: (userId: Tsid, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperDeleteResponse>>;
export declare const getDeleteUserByIdMutationOptions: <TError = AxiosError<SimpleResponseWrapperDeleteResponse>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUserById>>, TError, {
        userId: Tsid;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteUserById>>, TError, {
    userId: Tsid;
}, TContext>;
export type DeleteUserByIdMutationResult = NonNullable<Awaited<ReturnType<typeof deleteUserById>>>;
export type DeleteUserByIdMutationError = AxiosError<SimpleResponseWrapperDeleteResponse>;
export declare const useDeleteUserById: <TError = AxiosError<SimpleResponseWrapperDeleteResponse>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUserById>>, TError, {
        userId: Tsid;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteUserById>>, TError, {
    userId: Tsid;
}, TContext>;
/**
 * Search Users with Pagination
 */
export declare const searchUsers: (params: SearchUsersParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<PagingListResponseWrapperUser>>;
export declare const getSearchUsersQueryKey: (params: SearchUsersParams) => readonly ["/api/helixzypher/v1/users", ...SearchUsersParams[]];
export declare const getSearchUsersQueryOptions: <TData = Awaited<ReturnType<typeof searchUsers>>, TError = AxiosError<PagingListResponseWrapperUser>>(params: SearchUsersParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchUsers>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof searchUsers>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type SearchUsersQueryResult = NonNullable<Awaited<ReturnType<typeof searchUsers>>>;
export type SearchUsersQueryError = AxiosError<PagingListResponseWrapperUser>;
export declare function useSearchUsers<TData = Awaited<ReturnType<typeof searchUsers>>, TError = AxiosError<PagingListResponseWrapperUser>>(params: SearchUsersParams, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchUsers>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof searchUsers>>, TError, Awaited<ReturnType<typeof searchUsers>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useSearchUsers<TData = Awaited<ReturnType<typeof searchUsers>>, TError = AxiosError<PagingListResponseWrapperUser>>(params: SearchUsersParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchUsers>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof searchUsers>>, TError, Awaited<ReturnType<typeof searchUsers>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useSearchUsers<TData = Awaited<ReturnType<typeof searchUsers>>, TError = AxiosError<PagingListResponseWrapperUser>>(params: SearchUsersParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchUsers>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
/**
 * Create new User using given details
 */
export declare const createUser: (userCreateDto: UserCreateDto, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperUser>>;
export declare const getCreateUserMutationOptions: <TError = AxiosError<SimpleResponseWrapperUser>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createUser>>, TError, {
        data: UserCreateDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof createUser>>, TError, {
    data: UserCreateDto;
}, TContext>;
export type CreateUserMutationResult = NonNullable<Awaited<ReturnType<typeof createUser>>>;
export type CreateUserMutationBody = UserCreateDto;
export type CreateUserMutationError = AxiosError<SimpleResponseWrapperUser>;
export declare const useCreateUser: <TError = AxiosError<SimpleResponseWrapperUser>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createUser>>, TError, {
        data: UserCreateDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createUser>>, TError, {
    data: UserCreateDto;
}, TContext>;
/**
 * Find Users for suggestion boxes
 */
export declare const retrieveUserForSuggestions: (params: RetrieveUserForSuggestionsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<ListResponseWrapperUserSuggestion>>;
export declare const getRetrieveUserForSuggestionsQueryKey: (params: RetrieveUserForSuggestionsParams) => readonly ["/api/helixzypher/v1/users/suggestions", ...RetrieveUserForSuggestionsParams[]];
export declare const getRetrieveUserForSuggestionsQueryOptions: <TData = Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError = AxiosError<ListResponseWrapperUserSuggestion>>(params: RetrieveUserForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type RetrieveUserForSuggestionsQueryResult = NonNullable<Awaited<ReturnType<typeof retrieveUserForSuggestions>>>;
export type RetrieveUserForSuggestionsQueryError = AxiosError<ListResponseWrapperUserSuggestion>;
export declare function useRetrieveUserForSuggestions<TData = Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError = AxiosError<ListResponseWrapperUserSuggestion>>(params: RetrieveUserForSuggestionsParams, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError, Awaited<ReturnType<typeof retrieveUserForSuggestions>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveUserForSuggestions<TData = Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError = AxiosError<ListResponseWrapperUserSuggestion>>(params: RetrieveUserForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError, Awaited<ReturnType<typeof retrieveUserForSuggestions>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveUserForSuggestions<TData = Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError = AxiosError<ListResponseWrapperUserSuggestion>>(params: RetrieveUserForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveUserForSuggestions>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};