FamilyWall

Find the family's recipes by name, among those the family has planned before. A recipe in the family's recipe book that was never planned doesn't show here, but planning it by its exact name still uses it. Names that start with the query come first, then those with it as a whole word, then those that contain it. Each shows its id, name, and the prep_minutes, cook_minutes and serves it has. To put a recipe on a meal, call plan_meal with its name exactly as listed here; a name_cut name is too long to list whole. If several match, ask the member which.

find_recipes

Calendar events in a date range from every calendar the member has switched on (each occurrence of a repeating event is listed separately, with its own id and the series_id it belongs to). Times are in the member's own time zone. read_only events (not on the family calendar) can't be edited. `repeats` is custom for a repeat set in the app that the repeat names here don't cover.

list_events

The family's members: id, first name, role and whether they are an admin. Also says who "you" (the connected member) are.

list_members

Items on one list. By default only items that are not ticked off yet. A repeating item is done when its current occurrence is ticked off. `repeats` says how often, `due` is the occurrence to deal with now (the oldest missed one when `overdue`, else the next one) and `last_done` is the completion FamilyWall recorded last, which can be just before an occurrence rather than the time of the tick. `repeats` is custom for a repeat set in the app that the repeat names here don't cover.

list_items

The family's lists (shopping, to-dos and custom lists) with open/total item counts. An item counts as open as list_items shows it: a repeating item is open unless its current occurrence is done.

list_lists

The family's meal plan in a date range: for each day with something planned, its meals in the order of the family's day (meal is breakfast, lunch, snack, dinner, or custom1/custom2 for the family's own extra columns; meal_name is the family's own name for that meal, when it has one), each with a dish or the note the family wrote on that meal (a meal can have a note and no dish). Days with nothing planned are left out. To plan, move or change a meal, pass its meal key, never its meal_name.

list_meals

Move a planned meal to another day or meal, as dragging it does in the app's meal planner. The new meal must be one the family's planner shows, as in the app; a move to another day keeps the meal as it is. Without dishes the whole meal moves; with dishes only those move (names compared as plan_meal compares them). Dishes already on the new meal stay, and the moved ones are added alongside them. A whole meal takes its servings and note along, as the iOS app does: those it has replace the new meal's, and those it lacks leave the new meal's as they are (the reply says what was replaced). Moving only some dishes leaves the servings and note where they are. A member who isn't a family admin can't move dishes onto a meal that has another member's dishes, as in the app; an empty meal is fine. Returns both meals as read back.

move_meal

Put one or more dishes on a day's meal, as in the app's meal planner: breakfast, lunch, snack, dinner, or custom1/custom2 for the family's own extra meals. Only a meal the family's planner shows can take dishes, as in the app; the error names those it shows. Dishes already on that meal (the same name as FamilyWall compares them: case, spaces and most accents ignored, punctuation counted) are skipped, not doubled. FamilyWall reuses a family recipe with such a name; one the meal plan shows is sent in its own spelling, so it isn't renamed; use a recipe's name exactly as find_recipes lists it to add that recipe. servings is set only on a meal that has none yet; a meal that already has a count keeps it (the reply says so). Returns the planned dishes as read back.

plan_meal

Find events, lists, list items, members and meals (dish names and meal notes) whose text contains the query. Events and meals are searched from days_back before today to days_ahead after it.

search_family_data

Change how many people a planned meal serves, as in the app's meal planner. The meal must have a dish on it (plan one with plan_meal first). Returns the meal's servings as read back, and the count it had before.

set_meal_servings

Tick off (or untick) list items. Any family member can do this for any item they can see, as in the app. Confirm with the member first when changing more than 5 items. Each result is read back from FamilyWall. A tick on an `overdue` repeating item clears every missed occurrence, and a second tick ticks the current one. Its `last_done` moves, and `done` and `due` show where it stands after. An untick reopens only the current occurrence: `last_done` moves to just before the last one already due, or clears if none is. A repeat that has ended can't be reopened once its last occurrence is done: that untick is `failed`, as is any tick or untick of a repeating item with no due date. An item that already reads that way is not sent (`already_that_way`). If FamilyWall stops answering, the call stops there: `sent_unverified` items may or may not have changed, `not_sent` ones weren't tried.

set_items_done

One-call summary of the family's 7 days from start_date (today by default): events grouped by day, planned meals (a dish `name`, or the `note` the family wrote on a meal, with `meal_name` where the family named that meal), and how many items are still open on each list. Use this first for "what's on this week?".

get_week_overview