nodes/generated

Interface BeeminderNodeParameters

Source
interface BeeminderNodeParameters {
    additionalFields?:
        | {
            comment?: string;
            requestid?: string;
            timestamp?: string;
        }
        | { dryrun?: boolean; note?: string }
        | {
            datapublic?: boolean;
            datasource?: "api" | "manual" | "ifttt" | "zapier";
            dryrun?: boolean;
            goaldate?: string;
            goalval?: number;
            initval?: number;
            rate?: number;
            secret?: boolean;
            tags?: string;
        }
        | { datapoints?: boolean; emaciated?: boolean }
        | {
            associations?: boolean;
            datapoints_count?: number;
            diff_since?: string;
            emaciated?: boolean;
            skinny?: boolean;
        }
        | { emaciated?: boolean };
    amount?: number;
    authentication?: "oAuth2" | "apiToken";
    datapointId?: string;
    datapoints?: string;
    goal_type?:
        | "custom"
        | "hustler"
        | "biker"
        | "fatloser"
        | "gainer"
        | "inboxer"
        | "drinker";
    goalName?: string;
    gunits?: string;
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "createAll"
    | "getArchived"
    | "refresh"
    | "shortCircuit"
    | "stepDown"
    | "cancelStepDown"
    | "uncle";
    options?: {
        page?: number;
        per?: number;
        sort?: string;
    };
    resource?: "user"
    | "charge"
    | "datapoint"
    | "goal";
    returnAll?: boolean;
    slug?: string;
    title?: string;
    updateFields?:
        | {
            datapublic?: boolean;
            datasource?: ""
            | "api"
            | "ifttt"
            | "zapier";
            roadall?: string;
            secret?: boolean;
            tags?: string;
            title?: string;
            tmax?: string;
            tmin?: string;
            yaxis?: string;
        }
        | {
            comment?: string;
            timestamp?: string;
            value?: number;
        };
    value?: number;
}

Properties§

Source§

readonly additionalFields?:
    | {
        comment?: string;
        requestid?: string;
        timestamp?: string;
    }
    | { dryrun?: boolean; note?: string }
    | {
        datapublic?: boolean;
        datasource?: "api" | "manual" | "ifttt" | "zapier";
        dryrun?: boolean;
        goaldate?: string;
        goalval?: number;
        initval?: number;
        rate?: number;
        secret?: boolean;
        tags?: string;
    }
    | { datapoints?: boolean; emaciated?: boolean }
    | {
        associations?: boolean;
        datapoints_count?: number;
        diff_since?: string;
        emaciated?: boolean;
        skinny?: boolean;
    }
    | { emaciated?: boolean }

Default: {}

Source§

readonly amount?: number

Charge amount in USD

Source§

readonly authentication?: "oAuth2" | "apiToken"

Default: "apiToken"

Source§

readonly datapointId?: string

Source§

readonly datapoints?: string

Array of datapoint objects to create. Each object should contain value and optionally timestamp, comment, etc. Default: "[]"

Source§

readonly goal_type?:
    | "custom"
    | "hustler"
    | "biker"
    | "fatloser"
    | "gainer"
    | "inboxer"
    | "drinker"

Type of goal. More info here.. Default: "hustler"

Source§

readonly goalName?: string

The name of the goal. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getGoals"}

Source§

readonly gunits?: string

Units for the goal (e.g., "hours", "pages", "pounds")

Source§

readonly limit?: number

Max number of results to return Default: 30 Type options: {"minValue":1,"maxValue":300}

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "createAll"
    | "getArchived"
    | "refresh"
    | "shortCircuit"
    | "stepDown"
    | "cancelStepDown"
    | "uncle"

Default: "create"

Source§

readonly options?: { page?: number; per?: number; sort?: string }

Default: {}

Source§

readonly resource?: "user" | "charge" | "datapoint" | "goal"

Default: "datapoint"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly slug?: string

Unique identifier for the goal

Source§

readonly title?: string

Human-readable title for the goal

Source§

readonly updateFields?:
    | {
        datapublic?: boolean;
        datasource?: ""
        | "api"
        | "ifttt"
        | "zapier";
        roadall?: string;
        secret?: boolean;
        tags?: string;
        title?: string;
        tmax?: string;
        tmin?: string;
        yaxis?: string;
    }
    | {
        comment?: string;
        timestamp?: string;
        value?: number;
    }

Default: {}

Source§

readonly value?: number

Datapoint value to send Default: 1