Schemas

Household.HouseholdActivityEntryData

id

string · required

household_id

string · required

event_type

string · required

occurred_at

string · date-time · required

payload

string[] · required

Household.HouseholdInviteData

id

string · required

household_id

string · required

invited_email

string · required

invited_by_user_id

integer · required

expires_at

string · date-time · required

created_at

string · date-time · required

self

string · required

accepted_at

string | null · date-time

accepted_by_user_id

integer | null

revoked_at

string | null · date-time

Household.HouseholdJoinLinkData

id

string · required

household_id

string · required

url

string · required

created_at

string · date-time · required

self

string · required

expires_at

string | null · date-time

Household.HouseholdMemberData

id

string · required

household_id

string · required

name

string · required

diet_tags

string[] · required

allergens

string[] · required

dislikes

string[] · required

created_at

string · date-time · required

updated_at

string · date-time · required

self

string · required

user_id

integer | null

birth_date

string | null · date-time

diet

string | null

pending_claim

array | null

pivot_role

string | null · enum

Enum values:

owner

member

guest

Household.ReceivedInviteData

id

string · required

household_name

string · required

inviter_display_name

string · required

role

string · required

expires_at

string · date-time · required

Household.StoreHouseholdRequest

Request body for POST /v1/households, D-34). Validation contract: - `name` REQUIRED string, 1–120 chars (Postgres-friendly bound, matches RenameHouseholdRequestData) - `locale` REQUIRED, must be a {@see SupportedLocale} value (D-34 single source of truth — `{nl, en}` today) D-32: locale is REQUIRED at the SDK contract layer; the SPA always sends it. The server-side User.locale fallback is intentionally NOT applied — defense-in-depth means rejecting requests that omit locale rather than silently picking one for non-SPA callers.

name

string · minLength: 1 · maxLength: 120 · required

locale

Localization.SupportedLocale · enum · required

Canonical set of supported UI locales for Happklaar. Use this enum wherever a value is constrained to one of the supported locales — Command DTOs, Query DTOs, validation attributes, repository filters. Backed string enum ensures the scalar value is preserved at the database/serialisation boundary (ADR 0034 convention). Add a new case here when a new locale is introduced; all #[In(SupportedLocale::Nl, SupportedLocale::En)] call-sites automatically benefit.

Enum values:

Localization.SupportedLocale

string · enum

Enum values:

Household.UpdateMemberRequestData

PATCH /v1/households/{id}/members/{member} request body. Partial-update wire shape (UpdateRecipeRequestData convention) — every field is `Optional` so omitting it means "leave * unchanged". Sending an explicit `null` on a nullable field means "clear it". Per Req 10 / D-24, the controller layer rejects diet+dislikes mutations for account-linked members (user_id NOT NULL) — the server-side check lives in {@see UpdateHouseholdMemberCommandHandler} because the membership state isn't available at request-validation time without a DB lookup. : `role` field REMOVED — the per-plate adult/child taxonomy is gone. `birth_date` (nullable CarbonImmutable) added; clearing requires explicit null. `diet` is constrained to the same enum used by `users.dietary_preferences.diet_type` (Req 9 / D-23).

name

string · maxLength: 120

birth_date

string | null · date-time

diet

string | null · enum

Enum values:

omnivore

vegetarian

vegan

pescatarian

flexitarian

dislikes

string[]

Happklaar API

Schemas

Household.HouseholdActivityEntryData

id

string · required

household_id

string · required

event_type

string · required

occurred_at

string · date-time · required

payload

string[] · required

Household.HouseholdInviteData

id

string · required

household_id

string · required

invited_email

string · required

invited_by_user_id

integer · required

expires_at

string · date-time · required

created_at

string · date-time · required

self

string · required

accepted_at

string | null · date-time

accepted_by_user_id

integer | null

revoked_at

string | null · date-time

Household.HouseholdJoinLinkData

id

string · required

household_id

string · required

url

string · required

created_at

string · date-time · required

self

string · required

expires_at

string | null · date-time

Household.HouseholdMemberData

id

string · required

household_id

string · required

name

string · required

diet_tags

string[] · required

allergens

string[] · required

dislikes

string[] · required

created_at

string · date-time · required

updated_at

string · date-time · required

self

string · required

user_id

integer | null

birth_date

string | null · date-time

diet

string | null

pending_claim

array | null

pivot_role

string | null · enum

Enum values:

owner

member

guest

Household.ReceivedInviteData

id

string · required

household_name

string · required

inviter_display_name

string · required

role

string · required

expires_at

string · date-time · required

Household.StoreHouseholdRequest

name

string · minLength: 1 · maxLength: 120 · required

locale

Localization.SupportedLocale · enum · required

Enum values:

Localization.SupportedLocale

string · enum

Enum values:

Household.UpdateMemberRequestData

name

string · maxLength: 120

birth_date

string | null · date-time

diet

string | null · enum

Enum values:

omnivore

vegetarian

vegan

pescatarian

flexitarian

dislikes

string[]