@learnorama/mozaik-sdk 0.1.0 → 0.5.0-staging.22.1

package/dist/react/cvs-ils.d.ts

@@ -0,0 +1,552 @@
+
+import { Pn as ListIlsLoansParams, Sr as IlsAccountRead, _r as IlsHoldWrite, br as IlsHoldableRead, dr as IlsReviewWrite, fr as IlsPasswordWrite, ft as ReadIlsHoldableParams, hr as IlsLoanListRead, lr as IlsStatusRead, or as IlsTagWrite, pr as IlsLocationListRead, sr as IlsSuggestionOptionListRead, t as ValidationErrorResponse, ur as IlsSignInWrite, vr as IlsHoldListRead, wr as HTTPExceptionResponse, xr as IlsActionRead } from "../chunks/index.js";
+import { a as ErrorType, c as request, n as BodyType } from "../chunks/client.js";
+import { DataTag, DefinedInitialDataOptions, DefinedUseQueryResult, QueryClient, QueryKey, UndefinedInitialDataOptions, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from "@tanstack/react-query";
+//#region src/react/cvs-ils/cvs-ils.d.ts
+type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
+export declare const getReadIlsAccountUrl: () => string;
+/**
+ * The borrower record held by the library.
+ *
+ * Passed through unmodelled — PMB documents no shape for this call and the
+ * four libraries run different versions, so a fixed schema would drop exactly
+ * the fine and expiry fields a patron most needs.
+ * @summary Read Ils Account
+ */
+export declare const readIlsAccount: (options?: Parameters<typeof request>[1]) => Promise<IlsAccountRead>;
+export declare const getReadIlsAccountQueryKey: () => readonly [`/ils/account`];
+export declare const getReadIlsAccountQueryOptions: <TData = Awaited<ReturnType<typeof readIlsAccount>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsAccount>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof readIlsAccount>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ReadIlsAccountQueryResult = NonNullable<Awaited<ReturnType<typeof readIlsAccount>>>;
+export type ReadIlsAccountQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useReadIlsAccount<TData = Awaited<ReturnType<typeof readIlsAccount>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsAccount>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readIlsAccount>>, TError, Awaited<ReturnType<typeof readIlsAccount>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadIlsAccount<TData = Awaited<ReturnType<typeof readIlsAccount>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsAccount>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readIlsAccount>>, TError, Awaited<ReturnType<typeof readIlsAccount>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadIlsAccount<TData = Awaited<ReturnType<typeof readIlsAccount>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsAccount>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getListIlsHoldLocationsUrl: () => string;
+/**
+ * Branches a reservation may be collected from.
+ *
+ * A separate call from ``/ils/locations`` because it is a different list —
+ * not every branch accepts collections, and offering one that does not
+ * produces a hold the patron can never pick up.
+ * @summary List Ils Hold Locations
+ */
+export declare const listIlsHoldLocations: (options?: Parameters<typeof request>[1]) => Promise<IlsLocationListRead>;
+export declare const getListIlsHoldLocationsQueryKey: () => readonly [`/ils/hold-locations`];
+export declare const getListIlsHoldLocationsQueryOptions: <TData = Awaited<ReturnType<typeof listIlsHoldLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHoldLocations>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listIlsHoldLocations>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListIlsHoldLocationsQueryResult = NonNullable<Awaited<ReturnType<typeof listIlsHoldLocations>>>;
+export type ListIlsHoldLocationsQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useListIlsHoldLocations<TData = Awaited<ReturnType<typeof listIlsHoldLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHoldLocations>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsHoldLocations>>, TError, Awaited<ReturnType<typeof listIlsHoldLocations>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsHoldLocations<TData = Awaited<ReturnType<typeof listIlsHoldLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHoldLocations>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsHoldLocations>>, TError, Awaited<ReturnType<typeof listIlsHoldLocations>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsHoldLocations<TData = Awaited<ReturnType<typeof listIlsHoldLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHoldLocations>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getListIlsHoldsUrl: () => string;
+/**
+ * This patron's reservations, with their place in each queue.
+ * @summary List Ils Holds
+ */
+export declare const listIlsHolds: (options?: Parameters<typeof request>[1]) => Promise<IlsHoldListRead>;
+export declare const getListIlsHoldsQueryKey: () => readonly [`/ils/holds`];
+export declare const getListIlsHoldsQueryOptions: <TData = Awaited<ReturnType<typeof listIlsHolds>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHolds>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listIlsHolds>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListIlsHoldsQueryResult = NonNullable<Awaited<ReturnType<typeof listIlsHolds>>>;
+export type ListIlsHoldsQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useListIlsHolds<TData = Awaited<ReturnType<typeof listIlsHolds>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHolds>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsHolds>>, TError, Awaited<ReturnType<typeof listIlsHolds>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsHolds<TData = Awaited<ReturnType<typeof listIlsHolds>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHolds>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsHolds>>, TError, Awaited<ReturnType<typeof listIlsHolds>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsHolds<TData = Awaited<ReturnType<typeof listIlsHolds>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsHolds>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getPlaceIlsHoldUrl: () => string;
+/**
+ * Reserve a record, for collection at a branch.
+ *
+ * Check ``GET /ils/records/{record_id}/holdable`` first if you want to show
+ * the patron why not before they try — this returns the library's refusal
+ * either way.
+ * @summary Place Ils Hold
+ */
+export declare const placeIlsHold: (ilsHoldWrite: IlsHoldWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getPlaceIlsHoldMutationKey: () => readonly ['placeIlsHold'];
+export declare const getPlaceIlsHoldMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof placeIlsHold>>, TError, PlaceIlsHoldMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof placeIlsHold>>, TError, PlaceIlsHoldMutationVariables, TContext>;
+export type PlaceIlsHoldMutationResult = NonNullable<Awaited<ReturnType<typeof placeIlsHold>>>;
+export type PlaceIlsHoldMutationBody = BodyType<IlsHoldWrite>;
+export type PlaceIlsHoldMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type PlaceIlsHoldMutationVariables = {
+  data: BodyType<IlsHoldWrite>;
+};
+/**
+ * @summary Place Ils Hold
+ */
+export declare const usePlaceIlsHold: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof placeIlsHold>>, TError, PlaceIlsHoldMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof placeIlsHold>>, TError, PlaceIlsHoldMutationVariables, TContext>;
+export declare const getCancelIlsHoldUrl: (holdId: number) => string;
+/**
+ * Cancel a reservation. The library decides whether it may still be.
+ * @summary Cancel Ils Hold
+ */
+export declare const cancelIlsHold: (holdId: number, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getCancelIlsHoldMutationKey: () => readonly ['cancelIlsHold'];
+export declare const getCancelIlsHoldMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof cancelIlsHold>>, TError, CancelIlsHoldMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof cancelIlsHold>>, TError, CancelIlsHoldMutationVariables, TContext>;
+export type CancelIlsHoldMutationResult = NonNullable<Awaited<ReturnType<typeof cancelIlsHold>>>;
+export type CancelIlsHoldMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type CancelIlsHoldMutationVariables = {
+  holdId: number;
+};
+/**
+ * @summary Cancel Ils Hold
+ */
+export declare const useCancelIlsHold: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof cancelIlsHold>>, TError, CancelIlsHoldMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof cancelIlsHold>>, TError, CancelIlsHoldMutationVariables, TContext>;
+export declare const getListIlsLoansUrl: (params?: ListIlsLoansParams) => string;
+/**
+ * What this patron has out from their library.
+ *
+ * ``state`` replaces PMB's integer ``loan_type``. The wire values were 0, 1
+ * and 2 with the meanings in the vendor's documentation and nowhere in the
+ * URL; a client should not have to know that 2 means overdue.
+ * @summary List Ils Loans
+ */
+export declare const listIlsLoans: (params?: ListIlsLoansParams, options?: Parameters<typeof request>[1]) => Promise<IlsLoanListRead>;
+export declare const getListIlsLoansQueryKey: (params?: ListIlsLoansParams) => readonly ["/ils/loans", ...ListIlsLoansParams[]];
+export declare const getListIlsLoansQueryOptions: <TData = Awaited<ReturnType<typeof listIlsLoans>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params?: ListIlsLoansParams, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLoans>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listIlsLoans>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListIlsLoansQueryResult = NonNullable<Awaited<ReturnType<typeof listIlsLoans>>>;
+export type ListIlsLoansQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useListIlsLoans<TData = Awaited<ReturnType<typeof listIlsLoans>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params: undefined | ListIlsLoansParams, options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLoans>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsLoans>>, TError, Awaited<ReturnType<typeof listIlsLoans>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsLoans<TData = Awaited<ReturnType<typeof listIlsLoans>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params?: ListIlsLoansParams, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLoans>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsLoans>>, TError, Awaited<ReturnType<typeof listIlsLoans>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsLoans<TData = Awaited<ReturnType<typeof listIlsLoans>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(params?: ListIlsLoansParams, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLoans>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getRenewIlsLoanUrl: (barcode: string) => string;
+/**
+ * Extend one loan.
+ *
+ * Keyed on the **item barcode**, not a loan id, because that is what PMB
+ * renews — a physical copy — and it is the number printed on the book. It is
+ * also what ``GET /ils/loans`` returns as ``barcode``.
+ *
+ * A refusal is a ``200`` with ``ok: false``, not an error: "this cannot be
+ * renewed again" is the library's answer to a valid question, and the reason
+ * it gives is worth showing the patron.
+ * @summary Renew Ils Loan
+ */
+export declare const renewIlsLoan: (barcode: string, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getRenewIlsLoanMutationKey: () => readonly ['renewIlsLoan'];
+export declare const getRenewIlsLoanMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof renewIlsLoan>>, TError, RenewIlsLoanMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof renewIlsLoan>>, TError, RenewIlsLoanMutationVariables, TContext>;
+export type RenewIlsLoanMutationResult = NonNullable<Awaited<ReturnType<typeof renewIlsLoan>>>;
+export type RenewIlsLoanMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type RenewIlsLoanMutationVariables = {
+  barcode: string;
+};
+/**
+ * @summary Renew Ils Loan
+ */
+export declare const useRenewIlsLoan: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof renewIlsLoan>>, TError, RenewIlsLoanMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof renewIlsLoan>>, TError, RenewIlsLoanMutationVariables, TContext>;
+export declare const getListIlsLocationsUrl: () => string;
+/**
+ * Every branch in the library's catalogue.
+ * @summary List Ils Locations
+ */
+export declare const listIlsLocations: (options?: Parameters<typeof request>[1]) => Promise<IlsLocationListRead>;
+export declare const getListIlsLocationsQueryKey: () => readonly [`/ils/locations`];
+export declare const getListIlsLocationsQueryOptions: <TData = Awaited<ReturnType<typeof listIlsLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLocations>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listIlsLocations>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListIlsLocationsQueryResult = NonNullable<Awaited<ReturnType<typeof listIlsLocations>>>;
+export type ListIlsLocationsQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useListIlsLocations<TData = Awaited<ReturnType<typeof listIlsLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLocations>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsLocations>>, TError, Awaited<ReturnType<typeof listIlsLocations>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsLocations<TData = Awaited<ReturnType<typeof listIlsLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLocations>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsLocations>>, TError, Awaited<ReturnType<typeof listIlsLocations>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsLocations<TData = Awaited<ReturnType<typeof listIlsLocations>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsLocations>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getChangeIlsPasswordUrl: () => string;
+/**
+ * Change the password on the **library's** system.
+ *
+ * Not the Mozaik one. A patron who changes it here still signs in to this
+ * platform with their Mozaik credentials, and saying so in the UI avoids the
+ * support ticket.
+ * @summary Change Ils Password
+ */
+export declare const changeIlsPassword: (ilsPasswordWrite: IlsPasswordWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getChangeIlsPasswordMutationKey: () => readonly ['changeIlsPassword'];
+export declare const getChangeIlsPasswordMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof changeIlsPassword>>, TError, ChangeIlsPasswordMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof changeIlsPassword>>, TError, ChangeIlsPasswordMutationVariables, TContext>;
+export type ChangeIlsPasswordMutationResult = NonNullable<Awaited<ReturnType<typeof changeIlsPassword>>>;
+export type ChangeIlsPasswordMutationBody = BodyType<IlsPasswordWrite>;
+export type ChangeIlsPasswordMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type ChangeIlsPasswordMutationVariables = {
+  data: BodyType<IlsPasswordWrite>;
+};
+/**
+ * @summary Change Ils Password
+ */
+export declare const useChangeIlsPassword: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof changeIlsPassword>>, TError, ChangeIlsPasswordMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof changeIlsPassword>>, TError, ChangeIlsPasswordMutationVariables, TContext>;
+export declare const getReadIlsHoldableUrl: (recordId: number, params?: ReadIlsHoldableParams) => string;
+/**
+ * Whether this patron may reserve this record, and the library's reason.
+ * @summary Read Ils Holdable
+ */
+export declare const readIlsHoldable: (recordId: number, params?: ReadIlsHoldableParams, options?: Parameters<typeof request>[1]) => Promise<IlsHoldableRead>;
+export declare const getReadIlsHoldableQueryKey: (recordId: number, params?: ReadIlsHoldableParams) => readonly [`/ils/records/${number}/holdable`, ...ReadIlsHoldableParams[]];
+export declare const getReadIlsHoldableQueryOptions: <TData = Awaited<ReturnType<typeof readIlsHoldable>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(recordId: number, params?: ReadIlsHoldableParams, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsHoldable>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof readIlsHoldable>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ReadIlsHoldableQueryResult = NonNullable<Awaited<ReturnType<typeof readIlsHoldable>>>;
+export type ReadIlsHoldableQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useReadIlsHoldable<TData = Awaited<ReturnType<typeof readIlsHoldable>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(recordId: number, params: undefined | ReadIlsHoldableParams, options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsHoldable>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readIlsHoldable>>, TError, Awaited<ReturnType<typeof readIlsHoldable>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadIlsHoldable<TData = Awaited<ReturnType<typeof readIlsHoldable>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(recordId: number, params?: ReadIlsHoldableParams, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsHoldable>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readIlsHoldable>>, TError, Awaited<ReturnType<typeof readIlsHoldable>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadIlsHoldable<TData = Awaited<ReturnType<typeof readIlsHoldable>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(recordId: number, params?: ReadIlsHoldableParams, options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsHoldable>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getAddIlsReviewUrl: (recordId: number) => string;
+/**
+ * Post a review to the library's OPAC, where its other borrowers see it.
+ *
+ * Distinct from a Mozaik review: this one lives on the library's system and
+ * is not moderated here.
+ * @summary Add Ils Review
+ */
+export declare const addIlsReview: (recordId: number, ilsReviewWrite: IlsReviewWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getAddIlsReviewMutationKey: () => readonly ['addIlsReview'];
+export declare const getAddIlsReviewMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof addIlsReview>>, TError, AddIlsReviewMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof addIlsReview>>, TError, AddIlsReviewMutationVariables, TContext>;
+export type AddIlsReviewMutationResult = NonNullable<Awaited<ReturnType<typeof addIlsReview>>>;
+export type AddIlsReviewMutationBody = BodyType<IlsReviewWrite>;
+export type AddIlsReviewMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type AddIlsReviewMutationVariables = {
+  recordId: number;
+  data: BodyType<IlsReviewWrite>;
+};
+/**
+ * @summary Add Ils Review
+ */
+export declare const useAddIlsReview: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof addIlsReview>>, TError, AddIlsReviewMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addIlsReview>>, TError, AddIlsReviewMutationVariables, TContext>;
+export declare const getAddIlsTagUrl: (recordId: number) => string;
+/**
+ * Tag a record in the library's catalogue.
+ * @summary Add Ils Tag
+ */
+export declare const addIlsTag: (recordId: number, ilsTagWrite: IlsTagWrite, options?: Parameters<typeof request>[1]) => Promise<IlsActionRead>;
+export declare const getAddIlsTagMutationKey: () => readonly ['addIlsTag'];
+export declare const getAddIlsTagMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof addIlsTag>>, TError, AddIlsTagMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof addIlsTag>>, TError, AddIlsTagMutationVariables, TContext>;
+export type AddIlsTagMutationResult = NonNullable<Awaited<ReturnType<typeof addIlsTag>>>;
+export type AddIlsTagMutationBody = BodyType<IlsTagWrite>;
+export type AddIlsTagMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type AddIlsTagMutationVariables = {
+  recordId: number;
+  data: BodyType<IlsTagWrite>;
+};
+/**
+ * @summary Add Ils Tag
+ */
+export declare const useAddIlsTag: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof addIlsTag>>, TError, AddIlsTagMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof addIlsTag>>, TError, AddIlsTagMutationVariables, TContext>;
+export declare const getSignOutOfIlsUrl: () => string;
+/**
+ * Drop the link. Idempotent, and never fails on the library's account.
+ *
+ * Our copy of the session goes first. Telling PMB is best-effort: if the
+ * library is down, the patron is still signed out here, which is the part
+ * they asked for and the part that matters for a shared device.
+ * @summary Sign Out Of Ils
+ */
+export declare const signOutOfIls: (options?: Parameters<typeof request>[1]) => Promise<void>;
+export declare const getSignOutOfIlsMutationKey: () => readonly ['signOutOfIls'];
+export declare const getSignOutOfIlsMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof signOutOfIls>>, TError, void, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof signOutOfIls>>, TError, void, TContext>;
+export type SignOutOfIlsMutationResult = NonNullable<Awaited<ReturnType<typeof signOutOfIls>>>;
+export type SignOutOfIlsMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+/**
+ * @summary Sign Out Of Ils
+ */
+export declare const useSignOutOfIls: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof signOutOfIls>>, TError, void, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof signOutOfIls>>, TError, void, TContext>;
+export declare const getSignInToIlsUrl: () => string;
+/**
+ * Link this patron to their library account with their card credentials.
+ *
+ * Replaces ``login``, ``login-md5`` and ``login-aes``: those are three ways to
+ * carry one password to a server of unknown vintage, and the connector
+ * negotiates between them — AES first, because it is the only one that does
+ * not hand the library a password it can replay.
+ *
+ * **The credentials are not stored.** They open an upstream session and are
+ * discarded; the session is what persists, and it expires. That is why there
+ * is no silent re-login anywhere below — a patron whose session lapses is
+ * asked again, because we deliberately cannot do it for them.
+ *
+ * ``401`` for a wrong card number or password — the patron's, at their
+ * library, not their Mozaik credentials.
+ * @summary Sign In To Ils
+ */
+export declare const signInToIls: (ilsSignInWrite: IlsSignInWrite, options?: Parameters<typeof request>[1]) => Promise<IlsStatusRead>;
+export declare const getSignInToIlsMutationKey: () => readonly ['signInToIls'];
+export declare const getSignInToIlsMutationOptions: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof signInToIls>>, TError, SignInToIlsMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}) => UseMutationOptions<Awaited<ReturnType<typeof signInToIls>>, TError, SignInToIlsMutationVariables, TContext>;
+export type SignInToIlsMutationResult = NonNullable<Awaited<ReturnType<typeof signInToIls>>>;
+export type SignInToIlsMutationBody = BodyType<IlsSignInWrite>;
+export type SignInToIlsMutationError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export type SignInToIlsMutationVariables = {
+  data: BodyType<IlsSignInWrite>;
+};
+/**
+ * @summary Sign In To Ils
+ */
+export declare const useSignInToIls: <TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>, TContext = unknown>(options?: {
+  mutation?: UseMutationOptions<Awaited<ReturnType<typeof signInToIls>>, TError, SignInToIlsMutationVariables, TContext>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof signInToIls>>, TError, SignInToIlsMutationVariables, TContext>;
+export declare const getReadIlsStatusUrl: () => string;
+/**
+ * Whether this library has a catalogue system, and whether we speak it.
+ *
+ * **Read this first.** Most libraries have no ILS, and a client that assumes
+ * otherwise renders a "my loans" tab that can only ever answer ``409``.
+ *
+ * Never 409s itself — "there is no integration" is the answer, not an error.
+ * @summary Read Ils Status
+ */
+export declare const readIlsStatus: (options?: Parameters<typeof request>[1]) => Promise<IlsStatusRead>;
+export declare const getReadIlsStatusQueryKey: () => readonly [`/ils/status`];
+export declare const getReadIlsStatusQueryOptions: <TData = Awaited<ReturnType<typeof readIlsStatus>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsStatus>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof readIlsStatus>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ReadIlsStatusQueryResult = NonNullable<Awaited<ReturnType<typeof readIlsStatus>>>;
+export type ReadIlsStatusQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useReadIlsStatus<TData = Awaited<ReturnType<typeof readIlsStatus>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsStatus>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof readIlsStatus>>, TError, Awaited<ReturnType<typeof readIlsStatus>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadIlsStatus<TData = Awaited<ReturnType<typeof readIlsStatus>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsStatus>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof readIlsStatus>>, TError, Awaited<ReturnType<typeof readIlsStatus>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useReadIlsStatus<TData = Awaited<ReturnType<typeof readIlsStatus>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof readIlsStatus>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getListIlsSuggestionCategoriesUrl: () => string;
+/**
+ * Categories a purchase suggestion may name.
+ *
+ * The suggestion itself is not submitted here: PMB's OPAC borrower services
+ * expose the two vocabularies and no ``add_suggestion``, so the legacy could
+ * not submit one either. Carried because a client building a suggestion form
+ * needs them, and their absence would look like an oversight rather than the
+ * vendor's.
+ * @summary List Ils Suggestion Categories
+ */
+export declare const listIlsSuggestionCategories: (options?: Parameters<typeof request>[1]) => Promise<IlsSuggestionOptionListRead>;
+export declare const getListIlsSuggestionCategoriesQueryKey: () => readonly [`/ils/suggestion-categories`];
+export declare const getListIlsSuggestionCategoriesQueryOptions: <TData = Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListIlsSuggestionCategoriesQueryResult = NonNullable<Awaited<ReturnType<typeof listIlsSuggestionCategories>>>;
+export type ListIlsSuggestionCategoriesQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useListIlsSuggestionCategories<TData = Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError, Awaited<ReturnType<typeof listIlsSuggestionCategories>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsSuggestionCategories<TData = Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError, Awaited<ReturnType<typeof listIlsSuggestionCategories>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsSuggestionCategories<TData = Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionCategories>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare const getListIlsSuggestionSourcesUrl: () => string;
+/**
+ * Sources a purchase suggestion may cite. See the note on categories.
+ * @summary List Ils Suggestion Sources
+ */
+export declare const listIlsSuggestionSources: (options?: Parameters<typeof request>[1]) => Promise<IlsSuggestionOptionListRead>;
+export declare const getListIlsSuggestionSourcesQueryKey: () => readonly [`/ils/suggestion-sources`];
+export declare const getListIlsSuggestionSourcesQueryOptions: <TData = Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}) => UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError, TData> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export type ListIlsSuggestionSourcesQueryResult = NonNullable<Awaited<ReturnType<typeof listIlsSuggestionSources>>>;
+export type ListIlsSuggestionSourcesQueryError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>;
+export declare function useListIlsSuggestionSources<TData = Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options: {
+  query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError, Awaited<ReturnType<typeof listIlsSuggestionSources>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsSuggestionSources<TData = Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError, Awaited<ReturnType<typeof listIlsSuggestionSources>>>, 'initialData'>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+export declare function useListIlsSuggestionSources<TData = Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError = ErrorType<HTTPExceptionResponse | ValidationErrorResponse>>(options?: {
+  query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listIlsSuggestionSources>>, TError, TData>>;
+  request?: SecondParameter<typeof request>;
+}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
+  queryKey: DataTag<QueryKey, TData, TError>;
+};
+//#endregion
+//# sourceMappingURL=cvs-ils.d.ts.map