helixzypher-api-client/dist/api/generated/helixz-company-resource/helixz-company-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 { CompanyModifyDto, ListResponseWrapperCompanySuggestion, PagingListResponseWrapperCompany, RetrieveCompanyForSuggestionsParams, SearchCompaniesParams, SimpleResponseWrapperCompany, SimpleResponseWrapperDeleteResponse, Tsid } from "../../model";
/**
 * Find Company by given company id
 */
export declare const getCompanyById: (companyId: Tsid, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperCompany>>;
export declare const getGetCompanyByIdQueryKey: (companyId: Tsid) => readonly [`/api/helixzypher/v1/companies/${string}`];
export declare const getGetCompanyByIdQueryOptions: <TData = Awaited<ReturnType<typeof getCompanyById>>, TError = AxiosError<SimpleResponseWrapperCompany>>(companyId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getCompanyById>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getCompanyById>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type GetCompanyByIdQueryResult = NonNullable<Awaited<ReturnType<typeof getCompanyById>>>;
export type GetCompanyByIdQueryError = AxiosError<SimpleResponseWrapperCompany>;
export declare function useGetCompanyById<TData = Awaited<ReturnType<typeof getCompanyById>>, TError = AxiosError<SimpleResponseWrapperCompany>>(companyId: Tsid, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getCompanyById>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getCompanyById>>, TError, Awaited<ReturnType<typeof getCompanyById>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useGetCompanyById<TData = Awaited<ReturnType<typeof getCompanyById>>, TError = AxiosError<SimpleResponseWrapperCompany>>(companyId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getCompanyById>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getCompanyById>>, TError, Awaited<ReturnType<typeof getCompanyById>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useGetCompanyById<TData = Awaited<ReturnType<typeof getCompanyById>>, TError = AxiosError<SimpleResponseWrapperCompany>>(companyId: Tsid, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getCompanyById>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
/**
 * Update Company using given details
 */
export declare const updateCompany: (companyId: Tsid, companyModifyDto: CompanyModifyDto, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperCompany>>;
export declare const getUpdateCompanyMutationOptions: <TError = AxiosError<SimpleResponseWrapperCompany>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateCompany>>, TError, {
        companyId: Tsid;
        data: CompanyModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof updateCompany>>, TError, {
    companyId: Tsid;
    data: CompanyModifyDto;
}, TContext>;
export type UpdateCompanyMutationResult = NonNullable<Awaited<ReturnType<typeof updateCompany>>>;
export type UpdateCompanyMutationBody = CompanyModifyDto;
export type UpdateCompanyMutationError = AxiosError<SimpleResponseWrapperCompany>;
export declare const useUpdateCompany: <TError = AxiosError<SimpleResponseWrapperCompany>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateCompany>>, TError, {
        companyId: Tsid;
        data: CompanyModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updateCompany>>, TError, {
    companyId: Tsid;
    data: CompanyModifyDto;
}, TContext>;
/**
 * Delete Company by given Company id
 */
export declare const deleteCompanyById: (companyId: Tsid, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperDeleteResponse>>;
export declare const getDeleteCompanyByIdMutationOptions: <TError = AxiosError<SimpleResponseWrapperDeleteResponse>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteCompanyById>>, TError, {
        companyId: Tsid;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteCompanyById>>, TError, {
    companyId: Tsid;
}, TContext>;
export type DeleteCompanyByIdMutationResult = NonNullable<Awaited<ReturnType<typeof deleteCompanyById>>>;
export type DeleteCompanyByIdMutationError = AxiosError<SimpleResponseWrapperDeleteResponse>;
export declare const useDeleteCompanyById: <TError = AxiosError<SimpleResponseWrapperDeleteResponse>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteCompanyById>>, TError, {
        companyId: Tsid;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteCompanyById>>, TError, {
    companyId: Tsid;
}, TContext>;
/**
 * Soft delete Company by its ID. Marks the company as INACTIVE.
 */
export declare const updateCompanyStatus: (companyId: Tsid, status: "ACTIVE" | "INACTIVE", options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperCompany>>;
export declare const getUpdateCompanyStatusMutationOptions: <TError = AxiosError<SimpleResponseWrapperCompany>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateCompanyStatus>>, TError, {
        companyId: Tsid;
        status: "ACTIVE" | "INACTIVE";
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof updateCompanyStatus>>, TError, {
    companyId: Tsid;
    status: "ACTIVE" | "INACTIVE";
}, TContext>;
export type UpdateCompanyStatusMutationResult = NonNullable<Awaited<ReturnType<typeof updateCompanyStatus>>>;
export type UpdateCompanyStatusMutationError = AxiosError<SimpleResponseWrapperCompany>;
export declare const useUpdateCompanyStatus: <TError = AxiosError<SimpleResponseWrapperCompany>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateCompanyStatus>>, TError, {
        companyId: Tsid;
        status: "ACTIVE" | "INACTIVE";
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updateCompanyStatus>>, TError, {
    companyId: Tsid;
    status: "ACTIVE" | "INACTIVE";
}, TContext>;
/**
 * Search Companies with Pagination
 */
export declare const searchCompanies: (params: SearchCompaniesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<PagingListResponseWrapperCompany>>;
export declare const getSearchCompaniesQueryKey: (params: SearchCompaniesParams) => readonly ["/api/helixzypher/v1/companies", ...SearchCompaniesParams[]];
export declare const getSearchCompaniesQueryOptions: <TData = Awaited<ReturnType<typeof searchCompanies>>, TError = AxiosError<PagingListResponseWrapperCompany>>(params: SearchCompaniesParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchCompanies>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof searchCompanies>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type SearchCompaniesQueryResult = NonNullable<Awaited<ReturnType<typeof searchCompanies>>>;
export type SearchCompaniesQueryError = AxiosError<PagingListResponseWrapperCompany>;
export declare function useSearchCompanies<TData = Awaited<ReturnType<typeof searchCompanies>>, TError = AxiosError<PagingListResponseWrapperCompany>>(params: SearchCompaniesParams, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchCompanies>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof searchCompanies>>, TError, Awaited<ReturnType<typeof searchCompanies>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useSearchCompanies<TData = Awaited<ReturnType<typeof searchCompanies>>, TError = AxiosError<PagingListResponseWrapperCompany>>(params: SearchCompaniesParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchCompanies>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof searchCompanies>>, TError, Awaited<ReturnType<typeof searchCompanies>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useSearchCompanies<TData = Awaited<ReturnType<typeof searchCompanies>>, TError = AxiosError<PagingListResponseWrapperCompany>>(params: SearchCompaniesParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof searchCompanies>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
/**
 * Create new Company using given details
 */
export declare const createCompany: (companyModifyDto: CompanyModifyDto, options?: AxiosRequestConfig) => Promise<AxiosResponse<SimpleResponseWrapperCompany>>;
export declare const getCreateCompanyMutationOptions: <TError = AxiosError<SimpleResponseWrapperCompany>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createCompany>>, TError, {
        data: CompanyModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof createCompany>>, TError, {
    data: CompanyModifyDto;
}, TContext>;
export type CreateCompanyMutationResult = NonNullable<Awaited<ReturnType<typeof createCompany>>>;
export type CreateCompanyMutationBody = CompanyModifyDto;
export type CreateCompanyMutationError = AxiosError<SimpleResponseWrapperCompany>;
export declare const useCreateCompany: <TError = AxiosError<SimpleResponseWrapperCompany>, TContext = unknown>(options?: {
    mutation?: UseMutationOptions<Awaited<ReturnType<typeof createCompany>>, TError, {
        data: CompanyModifyDto;
    }, TContext>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createCompany>>, TError, {
    data: CompanyModifyDto;
}, TContext>;
/**
 * Find Companies for suggestion boxes
 */
export declare const retrieveCompanyForSuggestions: (params: RetrieveCompanyForSuggestionsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<ListResponseWrapperCompanySuggestion>>;
export declare const getRetrieveCompanyForSuggestionsQueryKey: (params: RetrieveCompanyForSuggestionsParams) => readonly ["/api/helixzypher/v1/companies/suggestions", ...RetrieveCompanyForSuggestionsParams[]];
export declare const getRetrieveCompanyForSuggestionsQueryOptions: <TData = Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError = AxiosError<ListResponseWrapperCompanySuggestion>>(params: RetrieveCompanyForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError, TData> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export type RetrieveCompanyForSuggestionsQueryResult = NonNullable<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>>;
export type RetrieveCompanyForSuggestionsQueryError = AxiosError<ListResponseWrapperCompanySuggestion>;
export declare function useRetrieveCompanyForSuggestions<TData = Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError = AxiosError<ListResponseWrapperCompanySuggestion>>(params: RetrieveCompanyForSuggestionsParams, options: {
    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError, Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveCompanyForSuggestions<TData = Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError = AxiosError<ListResponseWrapperCompanySuggestion>>(params: RetrieveCompanyForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError, Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>>, "initialData">;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};
export declare function useRetrieveCompanyForSuggestions<TData = Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError = AxiosError<ListResponseWrapperCompanySuggestion>>(params: RetrieveCompanyForSuggestionsParams, options?: {
    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof retrieveCompanyForSuggestions>>, TError, TData>>;
    axios?: AxiosRequestConfig;
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
    queryKey: DataTag<QueryKey, TData, TError>;
};