synapse-react-client/dist/synapse-queries/download/useDownloadList.d.ts

[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie

import { AddToDownloadListRequest, AddToDownloadListResponse, AddToDownloadListStatsRequest, AddToDownloadListStatsResponse } from '@sage-bionetworks/synapse-client';
import { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError';
import { ActionRequiredCount, ActionRequiredResponse, AddBatchOfFilesToDownloadListResponse, AvailableFilesRequest, AvailableFilesResponse, AvailableFilter, FilesStatisticsResponse, RemoveBatchOfFilesFromDownloadListRequest, RemoveBatchOfFilesFromDownloadListResponse, Sort } from '@sage-bionetworks/synapse-types';
import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';
export declare function useGetAvailableFilesToDownload(request: AvailableFilesRequest, options?: UseQueryOptions<AvailableFilesResponse, SynapseClientError>): import("@tanstack/react-query").UseQueryResult<AvailableFilesResponse, SynapseClientError>;
export declare function useGetAvailableFilesToDownloadInfinite<TData = InfiniteData<AvailableFilesResponse>>(sort?: Sort, filter?: AvailableFilter, options?: Partial<UseInfiniteQueryOptions<AvailableFilesResponse, SynapseClientError, TData, QueryKey, AvailableFilesResponse['nextPageToken']>>): import("@tanstack/react-query").UseInfiniteQueryResult<TData, SynapseClientError>;
export declare function useGetAllDownloadListActionsRequired(options?: Partial<UseQueryOptions<ActionRequiredCount[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<ActionRequiredCount[], SynapseClientError>;
export declare function useGetDownloadListActionsRequiredInfinite<TData = InfiniteData<ActionRequiredResponse>>(options?: Partial<UseInfiniteQueryOptions<ActionRequiredResponse, SynapseClientError, TData, QueryKey, ActionRequiredResponse['nextPageToken']>>): import("@tanstack/react-query").UseInfiniteQueryResult<TData, SynapseClientError>;
export declare function useGetDownloadListStatistics(options?: Partial<UseQueryOptions<FilesStatisticsResponse, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<FilesStatisticsResponse, SynapseClientError>;
export declare function useAddFileToDownloadList(options?: Partial<UseMutationOptions<AddBatchOfFilesToDownloadListResponse, SynapseClientError, {
    entityId: string;
    entityVersionNumber: number | undefined;
}>>): import("@tanstack/react-query").UseMutationResult<AddBatchOfFilesToDownloadListResponse, SynapseClientError, {
    entityId: string;
    entityVersionNumber: number | undefined;
}, unknown>;
export declare function useAddFileBatchToDownloadList(options?: Partial<UseMutationOptions<AddBatchOfFilesToDownloadListResponse, SynapseClientError, {
    fileEntityId: string;
    versionNumber?: number;
}[]>>): import("@tanstack/react-query").UseMutationResult<AddBatchOfFilesToDownloadListResponse, SynapseClientError, {
    fileEntityId: string;
    versionNumber?: number;
}[], unknown>;
export declare function useAddToDownloadList(options?: Partial<UseMutationOptions<AddToDownloadListResponse, SynapseClientError, AddToDownloadListRequest>>): import("@tanstack/react-query").UseMutationResult<AddToDownloadListResponse, SynapseClientError, AddToDownloadListRequest, unknown>;
export declare function useRemoveFilesFromDownloadList(options?: Partial<UseMutationOptions<RemoveBatchOfFilesFromDownloadListResponse, SynapseClientError, RemoveBatchOfFilesFromDownloadListRequest>>): import("@tanstack/react-query").UseMutationResult<RemoveBatchOfFilesFromDownloadListResponse, SynapseClientError, RemoveBatchOfFilesFromDownloadListRequest, unknown>;
export declare function useGetAddToDownloadListStats(addToDownloadListStatsRequest: AddToDownloadListStatsRequest, options?: {
    enabled?: boolean;
}): import("@tanstack/react-query").UseQueryResult<AddToDownloadListStatsResponse, Error>;
//# sourceMappingURL=useDownloadList.d.ts.map