@sargonpiraev/habitify-api-client/build/types.d.ts

A TypeScript client for the Habitify API with complete type safety and modern developer experience.

export interface ApiResponse<T> {
    message: string;
    data: T;
    version: string;
    status: boolean;
}
export type HabitStatus = 'in_progress' | 'completed' | 'failed' | 'skipped';
export type HabitOrderBy = 'priority' | 'reminder_time' | 'status';
export interface GetJournalParams {
    target_date?: string;
    order_by?: HabitOrderBy;
    status?: HabitStatus;
    area_id?: string;
    time_of_day?: TimeOfDay | TimeOfDay[];
}
export type Periodicity = 'daily' | 'weekly' | 'monthly';
export declare enum ActionStatus {
    NotDoneYet = 0,
    Done = 1
}
export declare enum MoodValue {
    Terrible = 1,
    Bad = 2,
    Okay = 3,
    Good = 4,
    Excellent = 5
}
export declare enum NoteType {
    Text = 1,
    Image = 2
}
export type UnitType = 'kM' | 'm' | 'ft' | 'yd' | 'mi' | 'L' | 'mL' | 'fl oz' | 'cup' | 'kg' | 'g' | 'mg' | 'oz' | 'lb' | 'mcg' | 'sec' | 'min' | 'hr' | 'J' | 'kJ' | 'kCal' | 'cal' | 'rep' | string;
export declare enum LogMethod {
    Manual = "manual",
    AppleHealth = "appleHealth",
    GoogleFit = "googleFit",
    SamsungHealth = "samsungHealth"
}
export declare enum TimeOfDay {
    Morning = "morning",
    Afternoon = "afternoon",
    Evening = "evening",
    AnyTime = "any_time"
}
export interface Goal {
    unit_type: UnitType;
    value: number;
    periodicity: Periodicity;
}
export interface Progress {
    current_value: number;
    target_value: number;
    unit_type: UnitType;
    periodicity: Periodicity;
    reference_date: string;
}
export interface Area {
    id: string;
    name: string;
    created_date: string;
    priority: string;
}
export interface Log {
    id: string;
    value: number;
    created_date: string;
    unit_type: UnitType;
    habit_id: string;
}
export type HabitStatusType = 'none' | 'in_progress' | 'completed' | 'skipped' | 'failed';
export interface GetHabitStatusResult {
    status: HabitStatusType;
    progress?: Progress;
}
export type UpdateHabitStatus = 'completed' | 'skipped' | 'none';
export interface AddLogParams {
    unit_type: UnitType;
    value: number;
    target_date: string;
}
export interface Habit {
    id: string;
    name: string;
    is_archived: boolean;
    start_date: string;
    time_of_day: TimeOfDay[];
    goal?: Goal;
    goal_history_items?: Goal[];
    log_method: LogMethod;
    recurrence: string;
    remind?: string[];
    area?: Area | null;
    created_date: string;
    priority: number;
    status?: HabitStatus;
    progress?: Progress;
}
export interface Mood {
    id: string;
    value: MoodValue;
    created_at: string;
}
export interface CreateMoodParams {
    value: MoodValue;
    created_at: string;
}
export interface UpdateMoodParams {
    value: MoodValue;
    created_at: string;
}
export interface Note {
    id: string;
    content: string;
    created_date: string;
    habit_id: string;
    note_type: NoteType;
    image_url?: string | null;
}
export interface AddTextNoteParams {
    content: string;
    created_at: string;
}
export interface AddImageNoteParams {
    image: File | Blob;
    created_at: string;
}
export interface DeleteNotesParams {
    from?: string;
    to?: string;
}
export interface Action {
    id: string;
    remind_at: string;
    status: ActionStatus;
    title: string;
    updated_at: string;
    habit_id: string;
}
export interface CreateActionParams {
    title: string;
    remind_at: string;
}
export interface UpdateActionParams {
    status?: ActionStatus;
    title?: string;
    remind_at?: string;
}
export interface GetHabitStatusParams {
    habit_id: string;
    target_date?: string;
}
export interface UpdateHabitStatusParams {
    habit_id: string;
    status: UpdateHabitStatus;
    target_date?: string;
}
export interface GetLogsParams {
    habit_id: string;
    from?: string;
    to?: string;
}
export interface AddLogParamsFull extends AddLogParams {
    habit_id: string;
}
export interface DeleteLogParams {
    habit_id: string;
    log_id: string;
}
export interface DeleteLogsParamsFull {
    habit_id: string;
    from?: string;
    to?: string;
}
export interface GetMoodsParams {
    target_date?: string;
}
export interface GetMoodParams {
    mood_id: string;
}
export type CreateMoodParamsFull = CreateMoodParams;
export interface UpdateMoodParamsFull extends UpdateMoodParams {
    mood_id: string;
}
export interface DeleteMoodParams {
    mood_id: string;
}
export type GetAreasParams = object;
export interface GetNotesParams {
    habit_id: string;
    from?: string;
    to?: string;
}
export interface AddTextNoteParamsFull extends AddTextNoteParams {
    habit_id: string;
}
export interface AddImageNoteParamsFull extends AddImageNoteParams {
    habit_id: string;
}
export interface DeleteNoteParams {
    habit_id: string;
    note_id: string;
}
export interface DeleteNotesParamsFull extends DeleteNotesParams {
    habit_id: string;
}
export interface GetActionsParams {
    habit_id: string;
}
export interface GetActionParams {
    habit_id: string;
    action_id: string;
}
export interface CreateActionParamsFull extends CreateActionParams {
    habit_id: string;
}
export interface UpdateActionParamsFull extends UpdateActionParams {
    habit_id: string;
    action_id: string;
}
export interface DeleteActionParams {
    habit_id: string;
    action_id: string;
}