@mft/moneyhub-api-client/dist/requests/types/spending-goals.d.ts

Node.JS client for the Moneyhub API

import { ApiResponse, ExtraOptions, SearchParams } from "../../request";
import { SpendingGoal } from "../../schema/spending-goal";
declare type SpendingGoalsPeriodType = "monthly" | "annual";
declare type Amount = {
    value: number;
};
export interface SpendingGoalsRequests {
    getSpendingGoals: (params: SearchParams, userId: string, options?: ExtraOptions) => Promise<ApiResponse<SpendingGoal[]>>;
    getSpendingGoal: ({ goalId, userId, }: {
        goalId: string;
        userId: string;
    }, options?: ExtraOptions) => Promise<ApiResponse<SpendingGoal>>;
    createSpendingGoal: ({ categoryId, periodType, periodStart, amount, userId, }: {
        categoryId: string;
        periodType?: SpendingGoalsPeriodType;
        periodStart?: string;
        amount: Amount;
        userId: string;
    }, options?: ExtraOptions) => Promise<ApiResponse<SpendingGoal>>;
    updateSpendingGoal: ({ goalId, categoryId, amount, userId, }: {
        goalId: string;
        categoryId?: string;
        amount?: Amount;
        userId: string;
    }, options?: ExtraOptions) => Promise<ApiResponse<SpendingGoal>>;
    deleteSpendingGoal: ({ goalId, userId, }: {
        goalId: string;
        userId: string;
    }, options?: ExtraOptions) => Promise<number>;
}
export {};
//# sourceMappingURL=spending-goals.d.ts.map