unlockpage-api-client
Version:
React hooks and TypeScript client for Unlockpage API
460 lines (459 loc) • 25.4 kB
TypeScript
import type { QueryKey, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from "@tanstack/react-query";
import type { AxiosError, AxiosRequestConfig, AxiosResponse } from "axios";
import type { BodyBody, DeleteRoutesParams, DeleteUser200, DeleteWebsiteParams, GetAuthCheck200, GetAvaliableParams, GetDns400, GetDns404, GetDns500, GetDnsParams, GetPurchaseHistoryParams, GetPurchased200, GetPurchasedParams, GetWebsiteParams, MicrohttpAccessResponse, MicrohttpDNSResponse, MicrohttpErrorResponse, MicrohttpPurchaseDetail, MicrohttpRoute, MicrohttpRouteInfo, MicrohttpUser, MicrohttpWebsite, PatchRoutesBody, PatchRoutesParams, PostAccessBody, PostDns400, PostDns404, PostDns500, PostDnsParams, PostUserLogout200, PutUser200 } from "./model";
/**
* Verify if user has purchased access to a specific URL/route
* @summary Check access to protected content
*/
export declare const postAccess: (postAccessBody: PostAccessBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpAccessResponse>>;
export declare const getPostAccessMutationOptions: <TError = AxiosError<MicrohttpErrorResponse>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof postAccess>>, TError, {
data: PostAccessBody;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof postAccess>>, TError, {
data: PostAccessBody;
}, TContext>;
export type PostAccessMutationResult = NonNullable<Awaited<ReturnType<typeof postAccess>>>;
export type PostAccessMutationBody = PostAccessBody;
export type PostAccessMutationError = AxiosError<MicrohttpErrorResponse>;
/**
* @summary Check access to protected content
*/
export declare const usePostAccess: <TError = AxiosError<MicrohttpErrorResponse>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof postAccess>>, TError, {
data: PostAccessBody;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof postAccess>>, TError, {
data: PostAccessBody;
}, TContext>;
/**
* Check if user has a valid session cookie
* @summary Check authentication status
*/
export declare const getAuthCheck: (options?: AxiosRequestConfig) => Promise<AxiosResponse<GetAuthCheck200>>;
export declare const getGetAuthCheckQueryKey: () => readonly ["https://micro-payments.fly.dev/auth/check"];
export declare const getGetAuthCheckQueryOptions: <TData = Awaited<ReturnType<typeof getAuthCheck>>, TError = AxiosError<string>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAuthCheck>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getAuthCheck>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetAuthCheckQueryResult = NonNullable<Awaited<ReturnType<typeof getAuthCheck>>>;
export type GetAuthCheckQueryError = AxiosError<string>;
/**
* @summary Check authentication status
*/
export declare const useGetAuthCheck: <TData = Awaited<ReturnType<typeof getAuthCheck>>, TError = AxiosError<string>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAuthCheck>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* Check if a route is available for purchase and get route information
* @summary Check route availability
*/
export declare const getAvaliable: (params: GetAvaliableParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpRouteInfo>>;
export declare const getGetAvaliableQueryKey: (params: GetAvaliableParams) => readonly ["https://micro-payments.fly.dev/avaliable", ...GetAvaliableParams[]];
export declare const getGetAvaliableQueryOptions: <TData = Awaited<ReturnType<typeof getAvaliable>>, TError = AxiosError<MicrohttpErrorResponse>>(params: GetAvaliableParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAvaliable>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getAvaliable>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetAvaliableQueryResult = NonNullable<Awaited<ReturnType<typeof getAvaliable>>>;
export type GetAvaliableQueryError = AxiosError<MicrohttpErrorResponse>;
/**
* @summary Check route availability
*/
export declare const useGetAvaliable: <TData = Awaited<ReturnType<typeof getAvaliable>>, TError = AxiosError<MicrohttpErrorResponse>>(params: GetAvaliableParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAvaliable>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* GET: Check DNS TXT record verification status, POST: Generate new TXT record for domain verification
* @summary DNS management for domain verification
*/
export declare const getDns: (bodyBody: BodyBody, params: GetDnsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpDNSResponse>>;
export declare const getGetDnsQueryKey: (bodyBody: BodyBody, params: GetDnsParams) => readonly ["https://micro-payments.fly.dev/dns", ...GetDnsParams[], BodyBody];
export declare const getGetDnsQueryOptions: <TData = Awaited<ReturnType<typeof getDns>>, TError = AxiosError<GetDns400 | GetDns404 | GetDns500>>(bodyBody: BodyBody, params: GetDnsParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDns>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getDns>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetDnsQueryResult = NonNullable<Awaited<ReturnType<typeof getDns>>>;
export type GetDnsQueryError = AxiosError<GetDns400 | GetDns404 | GetDns500>;
/**
* @summary DNS management for domain verification
*/
export declare const useGetDns: <TData = Awaited<ReturnType<typeof getDns>>, TError = AxiosError<GetDns400 | GetDns404 | GetDns500>>(bodyBody: BodyBody, params: GetDnsParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDns>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* GET: Check DNS TXT record verification status, POST: Generate new TXT record for domain verification
* @summary DNS management for domain verification
*/
export declare const postDns: (bodyBody: BodyBody, params: PostDnsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpDNSResponse>>;
export declare const getPostDnsMutationOptions: <TError = AxiosError<PostDns400 | PostDns404 | PostDns500>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof postDns>>, TError, {
data: BodyBody;
params: PostDnsParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof postDns>>, TError, {
data: BodyBody;
params: PostDnsParams;
}, TContext>;
export type PostDnsMutationResult = NonNullable<Awaited<ReturnType<typeof postDns>>>;
export type PostDnsMutationBody = BodyBody;
export type PostDnsMutationError = AxiosError<PostDns400 | PostDns404 | PostDns500>;
/**
* @summary DNS management for domain verification
*/
export declare const usePostDns: <TError = AxiosError<PostDns400 | PostDns404 | PostDns500>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof postDns>>, TError, {
data: BodyBody;
params: PostDnsParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof postDns>>, TError, {
data: BodyBody;
params: PostDnsParams;
}, TContext>;
/**
* Get purchase history for websites owned by the authenticated user
* @summary Get website purchase history
*/
export declare const getDomainsPurchaseHistory: (options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpPurchaseDetail[]>>;
export declare const getGetDomainsPurchaseHistoryQueryKey: () => readonly ["https://micro-payments.fly.dev/domains-purchase-history"];
export declare const getGetDomainsPurchaseHistoryQueryOptions: <TData = Awaited<ReturnType<typeof getDomainsPurchaseHistory>>, TError = AxiosError<MicrohttpErrorResponse>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDomainsPurchaseHistory>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getDomainsPurchaseHistory>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetDomainsPurchaseHistoryQueryResult = NonNullable<Awaited<ReturnType<typeof getDomainsPurchaseHistory>>>;
export type GetDomainsPurchaseHistoryQueryError = AxiosError<MicrohttpErrorResponse>;
/**
* @summary Get website purchase history
*/
export declare const useGetDomainsPurchaseHistory: <TData = Awaited<ReturnType<typeof getDomainsPurchaseHistory>>, TError = AxiosError<MicrohttpErrorResponse>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDomainsPurchaseHistory>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* Get all purchases made by the authenticated user
* @summary Get user purchase history
*/
export declare const getPurchaseHistory: (params?: GetPurchaseHistoryParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpPurchaseDetail[]>>;
export declare const getGetPurchaseHistoryQueryKey: (params?: GetPurchaseHistoryParams) => readonly ["https://micro-payments.fly.dev/purchase-history", ...GetPurchaseHistoryParams[]];
export declare const getGetPurchaseHistoryQueryOptions: <TData = Awaited<ReturnType<typeof getPurchaseHistory>>, TError = AxiosError<MicrohttpErrorResponse>>(params?: GetPurchaseHistoryParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getPurchaseHistory>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getPurchaseHistory>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetPurchaseHistoryQueryResult = NonNullable<Awaited<ReturnType<typeof getPurchaseHistory>>>;
export type GetPurchaseHistoryQueryError = AxiosError<MicrohttpErrorResponse>;
/**
* @summary Get user purchase history
*/
export declare const useGetPurchaseHistory: <TData = Awaited<ReturnType<typeof getPurchaseHistory>>, TError = AxiosError<MicrohttpErrorResponse>>(params?: GetPurchaseHistoryParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getPurchaseHistory>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* Check if user has already purchased access to a specific route
* @summary Check if route is purchased
*/
export declare const getPurchased: (params: GetPurchasedParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<GetPurchased200>>;
export declare const getGetPurchasedQueryKey: (params: GetPurchasedParams) => readonly ["https://micro-payments.fly.dev/purchased", ...GetPurchasedParams[]];
export declare const getGetPurchasedQueryOptions: <TData = Awaited<ReturnType<typeof getPurchased>>, TError = AxiosError<string>>(params: GetPurchasedParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getPurchased>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getPurchased>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetPurchasedQueryResult = NonNullable<Awaited<ReturnType<typeof getPurchased>>>;
export type GetPurchasedQueryError = AxiosError<string>;
/**
* @summary Check if route is purchased
*/
export declare const useGetPurchased: <TData = Awaited<ReturnType<typeof getPurchased>>, TError = AxiosError<string>>(params: GetPurchasedParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getPurchased>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* Retrieve all routes for websites owned by the authenticated user
* @summary Get user's routes
*/
export declare const getRoutes: (options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpRoute[]>>;
export declare const getGetRoutesQueryKey: () => readonly ["https://micro-payments.fly.dev/routes"];
export declare const getGetRoutesQueryOptions: <TData = Awaited<ReturnType<typeof getRoutes>>, TError = AxiosError<string>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRoutes>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getRoutes>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetRoutesQueryResult = NonNullable<Awaited<ReturnType<typeof getRoutes>>>;
export type GetRoutesQueryError = AxiosError<string>;
/**
* @summary Get user's routes
*/
export declare const useGetRoutes: <TData = Awaited<ReturnType<typeof getRoutes>>, TError = AxiosError<string>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getRoutes>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* Add a new route for a website that users can purchase access to
* @summary Register a new route
*/
export declare const putRoutes: (microhttpRoute: MicrohttpRoute, options?: AxiosRequestConfig) => Promise<AxiosResponse<string>>;
export declare const getPutRoutesMutationOptions: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof putRoutes>>, TError, {
data: MicrohttpRoute;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof putRoutes>>, TError, {
data: MicrohttpRoute;
}, TContext>;
export type PutRoutesMutationResult = NonNullable<Awaited<ReturnType<typeof putRoutes>>>;
export type PutRoutesMutationBody = MicrohttpRoute;
export type PutRoutesMutationError = AxiosError<string>;
/**
* @summary Register a new route
*/
export declare const usePutRoutes: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof putRoutes>>, TError, {
data: MicrohttpRoute;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof putRoutes>>, TError, {
data: MicrohttpRoute;
}, TContext>;
/**
* Delete a route. Can only delete if no purchases exist for the route
* @summary Delete an existing route
*/
export declare const deleteRoutes: (params: DeleteRoutesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<string>>;
export declare const getDeleteRoutesMutationOptions: <TError = AxiosError<MicrohttpErrorResponse>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteRoutes>>, TError, {
params: DeleteRoutesParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteRoutes>>, TError, {
params: DeleteRoutesParams;
}, TContext>;
export type DeleteRoutesMutationResult = NonNullable<Awaited<ReturnType<typeof deleteRoutes>>>;
export type DeleteRoutesMutationError = AxiosError<MicrohttpErrorResponse>;
/**
* @summary Delete an existing route
*/
export declare const useDeleteRoutes: <TError = AxiosError<MicrohttpErrorResponse>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteRoutes>>, TError, {
params: DeleteRoutesParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof deleteRoutes>>, TError, {
params: DeleteRoutesParams;
}, TContext>;
/**
* Update route path, cost, and/or disabled state. Can only update if no purchases exist and new route name doesn't conflict
* @summary Update an existing route
*/
export declare const patchRoutes: (patchRoutesBody: PatchRoutesBody, params: PatchRoutesParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<string>>;
export declare const getPatchRoutesMutationOptions: <TError = AxiosError<MicrohttpErrorResponse>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchRoutes>>, TError, {
data: PatchRoutesBody;
params: PatchRoutesParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof patchRoutes>>, TError, {
data: PatchRoutesBody;
params: PatchRoutesParams;
}, TContext>;
export type PatchRoutesMutationResult = NonNullable<Awaited<ReturnType<typeof patchRoutes>>>;
export type PatchRoutesMutationBody = PatchRoutesBody;
export type PatchRoutesMutationError = AxiosError<MicrohttpErrorResponse>;
/**
* @summary Update an existing route
*/
export declare const usePatchRoutes: <TError = AxiosError<MicrohttpErrorResponse>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof patchRoutes>>, TError, {
data: PatchRoutesBody;
params: PatchRoutesParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof patchRoutes>>, TError, {
data: PatchRoutesBody;
params: PatchRoutesParams;
}, TContext>;
/**
* Retrieve authenticated user's profile information
* @summary Get user information
*/
export declare const getUser: (options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpUser>>;
export declare const getGetUserQueryKey: () => readonly ["https://micro-payments.fly.dev/user"];
export declare const getGetUserQueryOptions: <TData = Awaited<ReturnType<typeof getUser>>, TError = AxiosError<string>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUser>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getUser>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetUserQueryResult = NonNullable<Awaited<ReturnType<typeof getUser>>>;
export type GetUserQueryError = AxiosError<string>;
/**
* @summary Get user information
*/
export declare const useGetUser: <TData = Awaited<ReturnType<typeof getUser>>, TError = AxiosError<string>>(options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getUser>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* Synchronize user data from JWT token and create secure session
* @summary Sync user data
*/
export declare const putUser: (options?: AxiosRequestConfig) => Promise<AxiosResponse<PutUser200>>;
export declare const getPutUserMutationOptions: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof putUser>>, TError, void, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof putUser>>, TError, void, TContext>;
export type PutUserMutationResult = NonNullable<Awaited<ReturnType<typeof putUser>>>;
export type PutUserMutationError = AxiosError<string>;
/**
* @summary Sync user data
*/
export declare const usePutUser: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof putUser>>, TError, void, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof putUser>>, TError, void, TContext>;
/**
* Delete all active sessions for the authenticated user
* @summary Delete all user sessions
*/
export declare const deleteUser: (options?: AxiosRequestConfig) => Promise<AxiosResponse<DeleteUser200>>;
export declare const getDeleteUserMutationOptions: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUser>>, TError, void, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteUser>>, TError, void, TContext>;
export type DeleteUserMutationResult = NonNullable<Awaited<ReturnType<typeof deleteUser>>>;
export type DeleteUserMutationError = AxiosError<string>;
/**
* @summary Delete all user sessions
*/
export declare const useDeleteUser: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteUser>>, TError, void, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof deleteUser>>, TError, void, TContext>;
/**
* Log out user by clearing session cookie and deleting session from database
* @summary User logout
*/
export declare const postUserLogout: (options?: AxiosRequestConfig) => Promise<AxiosResponse<PostUserLogout200>>;
export declare const getPostUserLogoutMutationOptions: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof postUserLogout>>, TError, void, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof postUserLogout>>, TError, void, TContext>;
export type PostUserLogoutMutationResult = NonNullable<Awaited<ReturnType<typeof postUserLogout>>>;
export type PostUserLogoutMutationError = AxiosError<string>;
/**
* @summary User logout
*/
export declare const usePostUserLogout: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof postUserLogout>>, TError, void, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof postUserLogout>>, TError, void, TContext>;
/**
* Retrieve all websites registered by the authenticated user
* @summary Get user's websites
*/
export declare const getWebsite: (params?: GetWebsiteParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<MicrohttpWebsite[]>>;
export declare const getGetWebsiteQueryKey: (params?: GetWebsiteParams) => readonly ["https://micro-payments.fly.dev/website", ...GetWebsiteParams[]];
export declare const getGetWebsiteQueryOptions: <TData = Awaited<ReturnType<typeof getWebsite>>, TError = AxiosError<string>>(params?: GetWebsiteParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWebsite>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryOptions<Awaited<ReturnType<typeof getWebsite>>, TError, TData> & {
queryKey: QueryKey;
};
export type GetWebsiteQueryResult = NonNullable<Awaited<ReturnType<typeof getWebsite>>>;
export type GetWebsiteQueryError = AxiosError<string>;
/**
* @summary Get user's websites
*/
export declare const useGetWebsite: <TData = Awaited<ReturnType<typeof getWebsite>>, TError = AxiosError<string>>(params?: GetWebsiteParams, options?: {
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getWebsite>>, TError, TData>>;
axios?: AxiosRequestConfig;
}) => UseQueryResult<TData, TError> & {
queryKey: QueryKey;
};
/**
* Register a new website for content monetization
* @summary Register a new website
*/
export declare const putWebsite: (microhttpWebsite: MicrohttpWebsite, options?: AxiosRequestConfig) => Promise<AxiosResponse<string>>;
export declare const getPutWebsiteMutationOptions: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof putWebsite>>, TError, {
data: MicrohttpWebsite;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof putWebsite>>, TError, {
data: MicrohttpWebsite;
}, TContext>;
export type PutWebsiteMutationResult = NonNullable<Awaited<ReturnType<typeof putWebsite>>>;
export type PutWebsiteMutationBody = MicrohttpWebsite;
export type PutWebsiteMutationError = AxiosError<string>;
/**
* @summary Register a new website
*/
export declare const usePutWebsite: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof putWebsite>>, TError, {
data: MicrohttpWebsite;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof putWebsite>>, TError, {
data: MicrohttpWebsite;
}, TContext>;
/**
* Delete a registered but unverified website
* @summary Remove a website
*/
export declare const deleteWebsite: (params: DeleteWebsiteParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<string>>;
export declare const getDeleteWebsiteMutationOptions: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteWebsite>>, TError, {
params: DeleteWebsiteParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteWebsite>>, TError, {
params: DeleteWebsiteParams;
}, TContext>;
export type DeleteWebsiteMutationResult = NonNullable<Awaited<ReturnType<typeof deleteWebsite>>>;
export type DeleteWebsiteMutationError = AxiosError<string>;
/**
* @summary Remove a website
*/
export declare const useDeleteWebsite: <TError = AxiosError<string>, TContext = unknown>(options?: {
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteWebsite>>, TError, {
params: DeleteWebsiteParams;
}, TContext>;
axios?: AxiosRequestConfig;
}) => UseMutationResult<Awaited<ReturnType<typeof deleteWebsite>>, TError, {
params: DeleteWebsiteParams;
}, TContext>;