synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
25 lines • 2.62 kB
TypeScript
import type { UserSubmissionSearchRequest, UserSubmissionSearchResponse } from '@sage-bionetworks/synapse-client';
import { SynapseClientError } from '@sage-bionetworks/synapse-client/util/SynapseClientError';
import { ACTSubmissionStatus, CreateSubmissionRequest, Submission, SubmissionSearchRequest, SubmissionSearchResponse, SubmissionStateChangeRequest } from '@sage-bionetworks/synapse-types';
import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';
export default function useGetDataAccessSubmission(submissionId: string | number, options?: Partial<UseQueryOptions<Submission, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<Submission, SynapseClientError>;
/**
* Retrieve a list of submissions for a given access requirement ID, where the calling user is an accessor. Allows to
* optionally filter by accessRequirement Ids, submission state and sort by the associated fields in the
* SubmissionSearchSort.
*
* https://rest-docs.synapse.org/rest/POST/dataAccessSubmission/userRequests.html
* @param params
* @param options
*/
export declare function useSearchAccessSubmissionUserRequestsInfinite<TData = InfiniteData<UserSubmissionSearchResponse>>(params?: UserSubmissionSearchRequest, options?: Partial<UseInfiniteQueryOptions<UserSubmissionSearchResponse, SynapseClientError, TData, QueryKey, UserSubmissionSearchResponse['nextPageToken']>>): import("@tanstack/react-query").UseInfiniteQueryResult<TData, SynapseClientError>;
export declare function useSearchAccessSubmissionsInfinite<TData = InfiniteData<SubmissionSearchResponse>>(params: SubmissionSearchRequest, options?: Partial<UseInfiniteQueryOptions<SubmissionSearchResponse, SynapseClientError, TData, QueryKey, SubmissionSearchResponse['nextPageToken']>>): import("@tanstack/react-query").UseInfiniteQueryResult<TData, SynapseClientError>;
export declare function useUpdateDataAccessSubmissionState(options?: UseMutationOptions<Submission, SynapseClientError, SubmissionStateChangeRequest>): import("@tanstack/react-query").UseMutationResult<Submission, SynapseClientError, SubmissionStateChangeRequest, unknown>;
export declare function useSubmitDataAccessRequest(options?: Partial<UseMutationOptions<ACTSubmissionStatus, SynapseClientError, {
request: CreateSubmissionRequest;
accessRequirementId: string;
}>>): import("@tanstack/react-query").UseMutationResult<ACTSubmissionStatus, SynapseClientError, {
request: CreateSubmissionRequest;
accessRequirementId: string;
}, unknown>;
//# sourceMappingURL=useDataAccessSubmission.d.ts.map