HomeHug

Use this when the person asks to add one or more things to the family list — tasks, meetings, habits, birthdays — including planning a day. Put every item in one call. Do not use it to change or cancel an existing item. A list is never one item: every thing to buy, bring or do is an item of its own, never the notes of another. An errand for a list is an item with its day and hour, and the things are items with no date; all of them go on one shelf named for the list in the person's language, which the server makes when the family has none.

add_items

Use this when the person has chosen what to do about a time clash that a change ran into: one of the free times offered, keep it as asked over the taken time, or another time they name. Do not use it before they have chosen.

answer_clash

Use this when the person says an item is not done after all, or wants a cancelled one back. Do not use it to add a new item.

reopen_item

Use this when the person says an item will not happen. on_date skips one day of a repeating item for everyone on it; only_me takes the person off the item for good (every day), leaving it to the others. Do not use it to move an item — use update_item.

cancel_item

Use this when the person asks to move, rename or otherwise change an existing item: time, people, notes, place, duration, reminders, shelf. Get the id from get_schedule first. Do not use it to cancel or complete an item.

update_item

Use this when you need items and their ids — to change, complete or cancel them — or to check the plan before answering. It shows the person nothing. Do not use it to show the plan: get_schedule shows it, once per answer.

find_items

Use this when the person says an item is done. For a repeating item it marks one day. Do not use it for a plan in the future.

complete_item

Use this when the person tells a lasting fact about someone in the family or the family itself, e.g. a size, an allergy, a door code. Do not use it for things to do — use add_items.

remember_fact

Use this when the person asks what is planned, what was done or what is still to do — today, a day, a stretch of up to 28 days, or the things with no date — for the family or one person, and to show the result of the changes made in an answer. It shows the HomeHug card. Call it once per answer, after the last change; put every view the person asked for in views. To find an item's id without showing anything, use find_items. It shows one of the HomeHug app's views, chosen with view from what the person asked. Dates are YYYY-MM-DD in the person's local time; with no dates and no view it shows today.

get_schedule

Use this when you need to know which HomeHug family member this connection acts as. Do not use it to read the schedule.

get_profile