/**
 * Rest client interface.
 *
 * The Rest Client provides a consistent interface for interacting with a collection
 * & resource. This is based off the typical REST API structure.
 *
 * @template RT Record type
 * @template CT Collection type
 * @template LP List params
 * @template CP Create params
 * @template UP Update params
 */
export interface RestClient<RT, CT, LP, CP, UP> {
    /**
     * Fetch the collection
     *
     * Accepts a set of parameters which can be used to filter the collection.
     * These params will be used as part of the cache key.
     *
     * Typically associated with GET /collection.
     *
     * @param params List params
     * @returns Promise of a collection.
     */
    list(params?: LP): Promise<CT>;
    /**
     * Create a new resource.
     *
     * Typically associated with POST /collection.
     *
     * @param params Create params.
     * @returns Promise of the created resource.
     */
    create(params: CP): Promise<RT>;
    /**
     * Fetch a resource with the given id.
     *
     * Typically associated with GET /collection/:id.
     *
     * @param id Id of the resource to view.
     * @returns Promise of the viewed resource.
     */
    view(id: string): Promise<RT>;
    /**
     * Update a resource with the given params.
     *
     * Typically associated with PUT /collection/:id.
     *
     * @param id Id of the resource to update
     * @param params Values to update the resource with.
     * @returns Promise of the updated resource.
     */
    update(id: string, params: UP): Promise<RT>;
    /**
     * Partially update a resource with the given params.
     *
     * Typically associated with PATCH /collection/:id.
     *
     * @param id Id of the resource to partially update
     * @param params Values to update the resource with.
     * @returns Promise of the partially updated resource.
     */
    partial(id: string, params: Partial<UP>): Promise<RT>;
    /**
     * Delete a resource.
     *
     * Typically associated with DELETE /collection/:id.
     *
     * @param id Id of the resource to delete.
     */
    remove(id: string): Promise<void>;
}
/**
 * Hook that returns a Rest client.
 *
 * This is always called in "hook position" so you can use dependent hooks
 * to create teh Rest client, if needed.
 *
 * See {@link RestClient | RestClient} for info on what needs to be returned.
 *
 * @template RT Record type
 * @template CT Collection type
 * @template LP List params
 * @template CP Create params
 * @template UP Update params
 */
export declare type useRestClientHook<RT, CT, LP, CP, UP> = () => RestClient<RT, CT, LP, CP, UP>;
/**
 * Create a default useRestClient hook that returns the default Rest client.
 *
 * @param collectionUrl Url of the collection.
 * @returns useRestClient hook to return the client.
 */
export declare const createDefaultUseRestClient: <RT, CT, LP extends Record<string, string>, CP, UP>(collectionUrl: string) => () => RestClient<RT, CT, LP, CP, UP>;