helixzypher-api-client/dist/api/generated/helixz-authority-resource/helixz-authority-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 { AuthorityModifyDto, ListResponseWrapperAuthoritySuggestion, PagingListResponseWrapperAuthority, RetrieveAuthorityForSuggestionsParams, SearchAuthoritiesParams, SimpleResponseWrapperAuthority, SimpleResponseWrapperDeleteResponse, Tsid } from "../../model";
/**
 * Find Authority by given authority id
 */
export declare const retrieveAuthorityById: (authorityId: Tsid, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperAuthority>>;
export declare const getRetrieveAuthorityByIdQueryKey: (authorityId: Tsid) => readonly [`/api/helixzypher/v1/authorities/${string}`];
export declare const getRetrieveAuthorityByIdQueryOptions: <TData = Awaited<ReturnType<typeof retrieveAuthorityById>>, TError = AxiosError<SimpleResponseWrapperAuthority>>(authorityId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityById>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityById>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type RetrieveAuthorityByIdQueryResult = NonNullable<Awaited<ReturnType<typeof retrieveAuthorityById>>>;
export type RetrieveAuthorityByIdQueryError = AxiosError<SimpleResponseWrapperAuthority>;
export declare function useRetrieveAuthorityById<TData = Awaited<ReturnType<typeof retrieveAuthorityById>>, TError = AxiosError<SimpleResponseWrapperAuthority>>(authorityId: Tsid, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityById>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveAuthorityById>>, TError, Awaited<ReturnType<typeof retrieveAuthorityById>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveAuthorityById<TData = Awaited<ReturnType<typeof retrieveAuthorityById>>, TError = AxiosError<SimpleResponseWrapperAuthority>>(authorityId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityById>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveAuthorityById>>, TError, Awaited<ReturnType<typeof retrieveAuthorityById>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveAuthorityById<TData = Awaited<ReturnType<typeof retrieveAuthorityById>>, TError = AxiosError<SimpleResponseWrapperAuthority>>(authorityId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityById>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
/**
 * Update Authority using given details
 */
export declare const updateAuthority: (authorityId: Tsid, authorityModifyDto: AuthorityModifyDto, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperAuthority>>;
export declare const getUpdateAuthorityMutationOptions: <TError = AxiosError<SimpleResponseWrapperAuthority>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateAuthority>>, TError, {
        authorityId: Tsid;
        data: AuthorityModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof updateAuthority>>, TError, {
    authorityId: Tsid;
    data: AuthorityModifyDto;
}, TContext>;
export type UpdateAuthorityMutationResult = NonNullable<Awaited<ReturnType<typeof updateAuthority>>>;
export type UpdateAuthorityMutationBody = AuthorityModifyDto;
export type UpdateAuthorityMutationError = AxiosError<SimpleResponseWrapperAuthority>;
export declare const useUpdateAuthority: <TError = AxiosError<SimpleResponseWrapperAuthority>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateAuthority>>, TError, {
        authorityId: Tsid;
        data: AuthorityModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updateAuthority>>, TError, {
    authorityId: Tsid;
    data: AuthorityModifyDto;
}, TContext>;
/**
 * Delete Authority by given authority id
 */
export declare const deleteAuthority: (authorityId: Tsid, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperDeleteResponse>>;
export declare const getDeleteAuthorityMutationOptions: <TError = AxiosError<SimpleResponseWrapperDeleteResponse>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteAuthority>>, TError, {
        authorityId: Tsid;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteAuthority>>, TError, {
    authorityId: Tsid;
}, TContext>;
export type DeleteAuthorityMutationResult = NonNullable<Awaited<ReturnType<typeof deleteAuthority>>>;
export type DeleteAuthorityMutationError = AxiosError<SimpleResponseWrapperDeleteResponse>;
export declare const useDeleteAuthority: <TError = AxiosError<SimpleResponseWrapperDeleteResponse>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteAuthority>>, TError, {
        authorityId: Tsid;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteAuthority>>, TError, {
    authorityId: Tsid;
}, TContext>;
/**
 * Update Authority status using given details
 */
export declare const updateAuthorityStatus: (authorityId: Tsid, status: "Active" | "Inactive", options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperAuthority>>;
export declare const getUpdateAuthorityStatusMutationOptions: <TError = AxiosError<SimpleResponseWrapperAuthority>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateAuthorityStatus>>, TError, {
        authorityId: Tsid;
        status: "Active" | "Inactive";
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof updateAuthorityStatus>>, TError, {
    authorityId: Tsid;
    status: "Active" | "Inactive";
}, TContext>;
export type UpdateAuthorityStatusMutationResult = NonNullable<Awaited<ReturnType<typeof updateAuthorityStatus>>>;
export type UpdateAuthorityStatusMutationError = AxiosError<SimpleResponseWrapperAuthority>;
export declare const useUpdateAuthorityStatus: <TError = AxiosError<SimpleResponseWrapperAuthority>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateAuthorityStatus>>, TError, {
        authorityId: Tsid;
        status: "Active" | "Inactive";
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updateAuthorityStatus>>, TError, {
    authorityId: Tsid;
    status: "Active" | "Inactive";
}, TContext>;
/**
 * Search Authorities with Pagination
 */
export declare const searchAuthorities: (params: SearchAuthoritiesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<PagingListResponseWrapperAuthority>>;
export declare const getSearchAuthoritiesQueryKey: (params: SearchAuthoritiesParams) => readonly ["/api/helixzypher/v1/authorities", ...SearchAuthoritiesParams[]];
export declare const getSearchAuthoritiesQueryOptions: <TData = Awaited<ReturnType<typeof searchAuthorities>>, TError = AxiosError<PagingListResponseWrapperAuthority>>(params: SearchAuthoritiesParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchAuthorities>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof searchAuthorities>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type SearchAuthoritiesQueryResult = NonNullable<Awaited<ReturnType<typeof searchAuthorities>>>;
export type SearchAuthoritiesQueryError = AxiosError<PagingListResponseWrapperAuthority>;
export declare function useSearchAuthorities<TData = Awaited<ReturnType<typeof searchAuthorities>>, TError = AxiosError<PagingListResponseWrapperAuthority>>(params: SearchAuthoritiesParams, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchAuthorities>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof searchAuthorities>>, TError, Awaited<ReturnType<typeof searchAuthorities>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useSearchAuthorities<TData = Awaited<ReturnType<typeof searchAuthorities>>, TError = AxiosError<PagingListResponseWrapperAuthority>>(params: SearchAuthoritiesParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchAuthorities>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof searchAuthorities>>, TError, Awaited<ReturnType<typeof searchAuthorities>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useSearchAuthorities<TData = Awaited<ReturnType<typeof searchAuthorities>>, TError = AxiosError<PagingListResponseWrapperAuthority>>(params: SearchAuthoritiesParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchAuthorities>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
/**
 * Create new Authority using given details
 */
export declare const createAuthority: (authorityModifyDto: AuthorityModifyDto, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperAuthority>>;
export declare const getCreateAuthorityMutationOptions: <TError = AxiosError<SimpleResponseWrapperAuthority>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createAuthority>>, TError, {
        data: AuthorityModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof createAuthority>>, TError, {
    data: AuthorityModifyDto;
}, TContext>;
export type CreateAuthorityMutationResult = NonNullable<Awaited<ReturnType<typeof createAuthority>>>;
export type CreateAuthorityMutationBody = AuthorityModifyDto;
export type CreateAuthorityMutationError = AxiosError<SimpleResponseWrapperAuthority>;
export declare const useCreateAuthority: <TError = AxiosError<SimpleResponseWrapperAuthority>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createAuthority>>, TError, {
        data: AuthorityModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createAuthority>>, TError, {
    data: AuthorityModifyDto;
}, TContext>;
/**
 * Find Authorities for suggestion boxes
 */
export declare const retrieveAuthorityForSuggestions: (params: RetrieveAuthorityForSuggestionsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<ListResponseWrapperAuthoritySuggestion>>;
export declare const getRetrieveAuthorityForSuggestionsQueryKey: (params: RetrieveAuthorityForSuggestionsParams) => readonly ["/api/helixzypher/v1/authorities/suggestions", ...RetrieveAuthorityForSuggestionsParams[]];
export declare const getRetrieveAuthorityForSuggestionsQueryOptions: <TData = Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError = AxiosError<ListResponseWrapperAuthoritySuggestion>>(params: RetrieveAuthorityForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type RetrieveAuthorityForSuggestionsQueryResult = NonNullable<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>>;
export type RetrieveAuthorityForSuggestionsQueryError = AxiosError<ListResponseWrapperAuthoritySuggestion>;
export declare function useRetrieveAuthorityForSuggestions<TData = Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError = AxiosError<ListResponseWrapperAuthoritySuggestion>>(params: RetrieveAuthorityForSuggestionsParams, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError, Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveAuthorityForSuggestions<TData = Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError = AxiosError<ListResponseWrapperAuthoritySuggestion>>(params: RetrieveAuthorityForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError, Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveAuthorityForSuggestions<TData = Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError = AxiosError<ListResponseWrapperAuthoritySuggestion>>(params: RetrieveAuthorityForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveAuthorityForSuggestions>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};