@cranberry-money/shared-services
Version:
Platform-agnostic API services with pure functions and dependency injection. Includes auth, portfolios, assets, countries, sectors, and more.
23 lines • 1.22 kB
TypeScript
import { AxiosInstance, AxiosResponse } from 'axios';
import type { CreateFavouriteAsset, FavouriteAsset, FavouriteAssetQueryParams, PaginatedResponse } from '@cranberry-money/shared-types';
/**
* Get paginated list of favourite assets for the current user.
*/
export declare const getFavouriteAssets: (apiClient: AxiosInstance, params?: FavouriteAssetQueryParams) => Promise<AxiosResponse<PaginatedResponse<FavouriteAsset>, any, {}>>;
/**
* Get next page number for infinite query pagination.
*/
export declare const getFavouriteAssetsNextPage: (lastPage: AxiosResponse<PaginatedResponse<FavouriteAsset>>) => number | undefined;
/**
* Add an asset to favourites.
*/
export declare const addFavouriteAsset: (apiClient: AxiosInstance, data: CreateFavouriteAsset) => Promise<AxiosResponse<FavouriteAsset, any, {}>>;
/**
* Remove an asset from favourites.
*/
export declare const removeFavouriteAsset: (apiClient: AxiosInstance, uuid: string) => Promise<AxiosResponse<any, any, {}>>;
/**
* Get a single favourite asset by UUID.
*/
export declare const getFavouriteAssetByUuid: (apiClient: AxiosInstance, uuid: string) => Promise<AxiosResponse<FavouriteAsset, any, {}>>;
//# sourceMappingURL=favouriteAssets.d.ts.map