synapse-react-client
Version:
[](https://badge.fury.io/js/synapse-react-client) [](https://github.com/prettier/prettie
31 lines • 7.76 kB
TypeScript
import { SynapseClientError } from '@/utils';
import { AccessApproval, AccessControlList, AccessRequirement, AccessRequirementSearchRequest, AccessRequirementSearchResponse, AccessRequirementStatus, ACTSubmissionStatus, CreateAccessApprovalRequest, ManagedACTAccessRequirementStatus, Renewal, Request, ResearchProject, WikiPageKey } from '@sage-bionetworks/synapse-types';
import { InfiniteData, QueryKey, UseInfiniteQueryOptions, UseMutationOptions, UseQueryOptions } from '@tanstack/react-query';
export declare function useGetAccessRequirements<T extends AccessRequirement>(accessRequirementId: string | number, options?: Partial<UseQueryOptions<T, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<import("@tanstack/query-core").NoInfer<T>, SynapseClientError>;
export declare function useGetAccessRequirementsForEntity(entityId: string, options?: Partial<UseQueryOptions<AccessRequirement[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<AccessRequirement[], SynapseClientError>;
export declare function useGetAccessRequirementsForTeam(teamId: string, options?: Partial<UseQueryOptions<AccessRequirement[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<AccessRequirement[], SynapseClientError>;
export declare function useGetAccessRequirementWikiPageKey(accessRequirementId: string, options?: Partial<UseQueryOptions<WikiPageKey, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<WikiPageKey, SynapseClientError>;
export declare function useCreateAccessRequirement<T extends AccessRequirement>(options?: UseMutationOptions<T, SynapseClientError, Partial<T>>): import("@tanstack/react-query").UseMutationResult<T, SynapseClientError, Partial<T>, unknown>;
export declare function useUpdateAccessRequirement<T extends AccessRequirement>(options?: UseMutationOptions<T, SynapseClientError, T>): import("@tanstack/react-query").UseMutationResult<T, SynapseClientError, T, unknown>;
export declare function useGetAccessRequirementACL(accessRequirementId: string, options?: Partial<UseQueryOptions<AccessControlList | null, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<AccessControlList | null, SynapseClientError>;
export declare function useDeleteAccessRequirementACL(options?: UseMutationOptions<void, SynapseClientError, string>): import("@tanstack/react-query").UseMutationResult<void, SynapseClientError, string, unknown>;
export declare function useCreateAccessRequirementACL(options?: UseMutationOptions<AccessControlList, SynapseClientError, AccessControlList>): import("@tanstack/react-query").UseMutationResult<AccessControlList, SynapseClientError, AccessControlList, unknown>;
export declare function useUpdateAccessRequirementACL(options?: UseMutationOptions<AccessControlList, SynapseClientError, AccessControlList>): import("@tanstack/react-query").UseMutationResult<AccessControlList, SynapseClientError, AccessControlList, unknown>;
export declare function useSearchAccessRequirementsInfinite<TData = InfiniteData<AccessRequirementSearchResponse>>(params: Omit<AccessRequirementSearchRequest, 'nextPageToken'>, options?: UseInfiniteQueryOptions<AccessRequirementSearchResponse, SynapseClientError, TData, QueryKey, AccessRequirementSearchResponse['nextPageToken']>): import("@tanstack/react-query").UseInfiniteQueryResult<TData, SynapseClientError>;
export declare function useCreateLockAccessRequirement(options?: Partial<UseMutationOptions<AccessRequirement, SynapseClientError, string>>): import("@tanstack/react-query").UseMutationResult<AccessRequirement, SynapseClientError, string, unknown>;
export declare function useGetAccessRequirementStatus<T extends AccessRequirementStatus | ManagedACTAccessRequirementStatus = AccessRequirementStatus>(accessRequirementId: string, options?: Partial<UseQueryOptions<T, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<import("@tanstack/query-core").NoInfer<T>, SynapseClientError>;
export declare function useGetAccessRequirementStatuses<T extends AccessRequirementStatus | ManagedACTAccessRequirementStatus = AccessRequirementStatus>(accessRequirementIds: string[]): (unknown extends T | import("@tanstack/query-core").InitialDataFunction<T> ? import("@tanstack/react-query").UseQueryResult<unknown extends T ? T : T, SynapseClientError> : (T extends (unknown extends T ? T : T) ? import("@tanstack/react-query").DefinedUseQueryResult<unknown extends T ? T : T, SynapseClientError> : T extends () => infer TInitialDataResult ? unknown extends TInitialDataResult ? import("@tanstack/react-query").UseQueryResult<unknown extends T ? T : T, SynapseClientError> : TInitialDataResult extends (unknown extends T ? T : T) ? import("@tanstack/react-query").DefinedUseQueryResult<unknown extends T ? T : T, SynapseClientError> : import("@tanstack/react-query").UseQueryResult<unknown extends T ? T : T, SynapseClientError> : import("@tanstack/react-query").UseQueryResult<unknown extends T ? T : T, SynapseClientError>) | (import("@tanstack/query-core").InitialDataFunction<T> extends infer T_1 ? T_1 extends import("@tanstack/query-core").InitialDataFunction<T> ? T_1 extends (unknown extends T ? T : T) ? import("@tanstack/react-query").DefinedUseQueryResult<unknown extends T ? T : T, SynapseClientError> : T_1 extends () => infer TInitialDataResult ? unknown extends TInitialDataResult ? import("@tanstack/react-query").UseQueryResult<unknown extends T ? T : T, SynapseClientError> : TInitialDataResult extends (unknown extends T ? T : T) ? import("@tanstack/react-query").DefinedUseQueryResult<unknown extends T ? T : T, SynapseClientError> : import("@tanstack/react-query").UseQueryResult<unknown extends T ? T : T, SynapseClientError> : import("@tanstack/react-query").UseQueryResult<unknown extends T ? T : T, SynapseClientError> : never : never))[];
export declare function useSortAccessRequirementIdsByCompletion(accessRequirementIds: string[], options?: Partial<UseQueryOptions<string[], SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<string[], SynapseClientError>;
export declare function useGetResearchProject(accessRequirementId: string, options?: Partial<UseQueryOptions<ResearchProject, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<ResearchProject, SynapseClientError>;
export declare function useUpdateResearchProject(options?: Partial<UseMutationOptions<ResearchProject, SynapseClientError, ResearchProject>>): import("@tanstack/react-query").UseMutationResult<ResearchProject, SynapseClientError, ResearchProject, unknown>;
export declare function useGetDataAccessRequestForUpdate(accessRequirementId: string, options?: Partial<UseQueryOptions<Request | Renewal, SynapseClientError>>): import("@tanstack/react-query").UseQueryResult<Request | Renewal, SynapseClientError>;
export declare function useUpdateDataAccessRequest(options?: UseMutationOptions<Request | Renewal, SynapseClientError, Request | Renewal>): import("@tanstack/react-query").UseMutationResult<Request | Renewal, SynapseClientError, Request | Renewal, unknown>;
export declare function useCreateAccessApproval(options?: UseMutationOptions<AccessApproval, SynapseClientError, CreateAccessApprovalRequest>): import("@tanstack/react-query").UseMutationResult<AccessApproval, SynapseClientError, CreateAccessApprovalRequest, unknown>;
export declare function useCancelDataAccessRequest(options?: UseMutationOptions<ACTSubmissionStatus, SynapseClientError, {
submissionId: string;
accessRequirementId: string;
}>): import("@tanstack/react-query").UseMutationResult<ACTSubmissionStatus, SynapseClientError, {
submissionId: string;
accessRequirementId: string;
}, unknown>;
//# sourceMappingURL=useAccessRequirements.d.ts.map