@azuro-org/toolkit/dist/utils/user/deleteUserFavorite.d.ts

This framework-agnostic package provides essential utilities for building applications on the Azuro Protocol.

import { type ChainId } from '../../config';
export type DeleteUserFavoriteParams = {
    chainId: ChainId;
    token: string;
    favoritesId: string;
};
export type DeleteUserFavoriteResult = {
    favoritesId: string;
    success: boolean;
};
/**
 * Deletes a user favorite by its ID via an authenticated DELETE request.
 * Requires a valid Bearer JWT obtained from `verifySiwe`.
 *
 * - Auth: `Authorization: Bearer <token>` (see {@link https://gem.azuro.org/hub/apps/toolkit/auth/verifySiwe verifySiwe})
 * - Docs: https://gem.azuro.org/hub/apps/toolkit/user/deleteUserFavorite
 *
 * @example
 * import { deleteUserFavorite } from '@azuro-org/toolkit'
 *
 * const { success } = await deleteUserFavorite({
 *   chainId: 137,
 *   token: jwtToken,
 *   favoritesId: 'abc-123',
 * })
 *
 * console.log(success) // true
 * */
export declare const deleteUserFavorite: (props: DeleteUserFavoriteParams) => Promise<DeleteUserFavoriteResult>;