@kusinta/iot-schema 0.2.0-beta.5 → 0.2.0-beta.51

package/src/kusinta/iot/webrtc/v1/household_pb.d.ts

@@ -0,0 +1,612 @@
+// @generated by protoc-gen-es v2.12.0 with parameter "target=js+dts,import_extension=js"
+// @generated from file kusinta/iot/webrtc/v1/household.proto (package kusinta.iot.webrtc.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
+import type { Message } from "@bufbuild/protobuf";
+import type { SpaceId, UserId } from "../../identity/v1/identity_pb.js";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import type { ApartmentClimateSummary, RoomClimateList, RoomHistory } from "../../climate/v1/climate_pb.js";
+import type { CommissioningProfile } from "../../commissioning/v1/commissioning_pb.js";
+import type { HeatingLayout } from "../../heating/v1/heating_pb.js";
+
+/**
+ * Describes the file kusinta/iot/webrtc/v1/household.proto.
+ */
+export declare const file_kusinta_iot_webrtc_v1_household: GenFile;
+
+/**
+ * Makes a household admin of a home a resident again, at once; their residency continues
+ * (access.v1.MembershipRelation, HOUSEHOLD ADMIN). Answered with ManagementAck.
+ *
+ * A household admin of the home only; anyone else is refused as NOT_ENTITLED. user_id is
+ * never a residency id (INVALID_REQUEST). A resident of the home who is not a household admin
+ * is acknowledged and nothing changes; anyone else is "not_a_member", as members.proto has it.
+ * A demotion that would leave the home with no household admin is refused as
+ * "last_household_admin" (LAST ADMIN). Ends, with the demotion, the promotion requests the
+ * demoted member made for the home and the household invites they created there, with the
+ * join requests those invites made.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.DemoteHouseholdAdmin
+ */
+export declare type DemoteHouseholdAdmin = Message<"kusinta.iot.webrtc.v1.DemoteHouseholdAdmin"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.UserId user_id = 2;
+   */
+  userId?: UserId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.DemoteHouseholdAdmin.
+ * Use `create(DemoteHouseholdAdminSchema)` to create a new message.
+ */
+export declare const DemoteHouseholdAdminSchema: GenMessage<DemoteHouseholdAdmin>;
+
+/**
+ * One staff appointment of a household admin of a home, as its residents are told it.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.StaffAppointment
+ */
+export declare type StaffAppointment = Message<"kusinta.iot.webrtc.v1.StaffAppointment"> & {
+  /**
+   * The resident appointed.
+   *
+   * @generated from field: kusinta.iot.identity.v1.UserId appointee = 1;
+   */
+  appointee?: UserId | undefined;
+
+  /**
+   * The staff member who appointed them, and the name they gave their account
+   * (AppTokenClaims.name) as the gateway last learnt it; empty when none is learnt. Both are
+   * cleared once that account is deleted or removed from the gateway, when the record stays
+   * without them. Self-chosen, as MemberDetail.name is.
+   *
+   * @generated from field: kusinta.iot.identity.v1.UserId appointed_by = 2;
+   */
+  appointedBy?: UserId | undefined;
+
+  /**
+   * @generated from field: string appointed_by_name = 3;
+   */
+  appointedByName: string;
+
+  /**
+   * When the appointment took effect: the redeem, or the acceptance.
+   *
+   * @generated from field: google.protobuf.Timestamp at = 4;
+   */
+  at?: Timestamp | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.webrtc.v1.StaffAppointmentKind kind = 5;
+   */
+  kind: StaffAppointmentKind;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.StaffAppointment.
+ * Use `create(StaffAppointmentSchema)` to create a new message.
+ */
+export declare const StaffAppointmentSchema: GenMessage<StaffAppointment>;
+
+/**
+ * Starts the handover of one home (HANDOVER, 1), answered with the HouseholdHandover, PENDING.
+ * Anyone HANDOVER does not name is refused as NOT_ENTITLED. A space that is not an apartment is
+ * INVALID_REQUEST. Starting one while one is pending answers the pending one and starts
+ * nothing.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.StartHouseholdHandover
+ */
+export declare type StartHouseholdHandover = Message<"kusinta.iot.webrtc.v1.StartHouseholdHandover"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.StartHouseholdHandover.
+ * Use `create(StartHouseholdHandoverSchema)` to create a new message.
+ */
+export declare const StartHouseholdHandoverSchema: GenMessage<StartHouseholdHandover>;
+
+/**
+ * Confirms a pending handover (HANDOVER, 3–4; VACANCY). Answered with ManagementAck once every
+ * membership of the home has ended; the wipe follows, and the handover is pushed as DONE.
+ * Staff confirming before staff_confirmable_from are refused as FAILED_PRECONDITION with
+ * metadata {"reason": "notice_running"}. A handover that is not pending, or that the caller
+ * may not confirm, is refused as NOT_ENTITLED, so that no handover id can be probed.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ConfirmHouseholdHandover
+ */
+export declare type ConfirmHouseholdHandover = Message<"kusinta.iot.webrtc.v1.ConfirmHouseholdHandover"> & {
+  /**
+   * @generated from field: string handover_id = 1;
+   */
+  handoverId: string;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ConfirmHouseholdHandover.
+ * Use `create(ConfirmHouseholdHandoverSchema)` to create a new message.
+ */
+export declare const ConfirmHouseholdHandoverSchema: GenMessage<ConfirmHouseholdHandover>;
+
+/**
+ * Cancels a pending handover (HANDOVER, 3); nothing has changed, and nothing does. Answered
+ * with ManagementAck, and pushed as CANCELLED. A vacated one is refused as FAILED_PRECONDITION
+ * with metadata {"reason": "vacated"} (VACANCY). A handover that is not pending, or that the
+ * caller may not cancel, is refused as NOT_ENTITLED.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.CancelHouseholdHandover
+ */
+export declare type CancelHouseholdHandover = Message<"kusinta.iot.webrtc.v1.CancelHouseholdHandover"> & {
+  /**
+   * @generated from field: string handover_id = 1;
+   */
+  handoverId: string;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.CancelHouseholdHandover.
+ * Use `create(CancelHouseholdHandoverSchema)` to create a new message.
+ */
+export declare const CancelHouseholdHandoverSchema: GenMessage<CancelHouseholdHandover>;
+
+/**
+ * Lists the pending handovers of the homes under a space the caller may be told of, answered
+ * with HouseholdHandovers: unset root_space_id, every one. A home's handover is told to its
+ * residents, and to the property owner and the gateway administrators who reach it; a
+ * vacated one to the departing household instead of residents (VACANCY). Anyone may
+ * ask; nobody is refused, and a caller told of none gets none.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ListHouseholdHandovers
+ */
+export declare type ListHouseholdHandovers = Message<"kusinta.iot.webrtc.v1.ListHouseholdHandovers"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId root_space_id = 1;
+   */
+  rootSpaceId?: SpaceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ListHouseholdHandovers.
+ * Use `create(ListHouseholdHandoversSchema)` to create a new message.
+ */
+export declare const ListHouseholdHandoversSchema: GenMessage<ListHouseholdHandovers>;
+
+/**
+ * One handover of one home (HANDOVER), as told to one caller.
+ *
+ * The answer to StartHouseholdHandover, and pushed as GatewayMessage.household_handover to
+ * every session it is told to (ListHouseholdHandovers) whenever it is started, cancelled or
+ * done, or its staff_confirmable_from moves: to the household, the notice. A DONE push
+ * reaches the household's sessions before they lose the home.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.HouseholdHandover
+ */
+export declare type HouseholdHandover = Message<"kusinta.iot.webrtc.v1.HouseholdHandover"> & {
+  /**
+   * Minted by the gateway, opaque.
+   *
+   * @generated from field: string handover_id = 1;
+   */
+  handoverId: string;
+
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 2;
+   */
+  homeId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: kusinta.iot.webrtc.v1.HouseholdHandoverState state = 3;
+   */
+  state: HouseholdHandoverState;
+
+  /**
+   * Who started it, and the name they gave their account (AppTokenClaims.name) as the gateway
+   * last learnt it. Given to the household; to anyone else only when started_by_staff, and
+   * unset otherwise, since a resident's user id would say where they live. The name is
+   * self-chosen, as MemberDetail.name is.
+   *
+   * @generated from field: kusinta.iot.identity.v1.UserId started_by = 4;
+   */
+  startedBy?: UserId | undefined;
+
+  /**
+   * @generated from field: string started_by_name = 5;
+   */
+  startedByName: string;
+
+  /**
+   * Set when the property owner or a gateway administrator started it, rather than the
+   * household. Neither this nor started_by is set when it was vacated.
+   *
+   * @generated from field: bool started_by_staff = 6;
+   */
+  startedByStaff: boolean;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp started_at = 7;
+   */
+  startedAt?: Timestamp | undefined;
+
+  /**
+   * From when the property owner or a gateway administrator may confirm it, and when a vacated
+   * one completes on its own: 7 days after started_at, and never sooner than 7 days after the
+   * home's last residency ended. On a handover that is not vacated, a residency that starts
+   * while it is pending moves it to 7 days after that, and the handover is pushed again, so
+   * that a household that moves in during it has its notice too; on a vacated one, a new
+   * household moving in completes it instead (QUICK TURNOVER).
+   *
+   * @generated from field: google.protobuf.Timestamp staff_confirmable_from = 8;
+   */
+  staffConfirmableFrom?: Timestamp | undefined;
+
+  /**
+   * When it was cancelled or done. Unset while pending.
+   *
+   * @generated from field: google.protobuf.Timestamp ended_at = 9;
+   */
+  endedAt?: Timestamp | undefined;
+
+  /**
+   * Set when the home's last residency ending started it, rather than a request (VACANCY).
+   *
+   * @generated from field: bool vacated = 10;
+   */
+  vacated: boolean;
+
+  /**
+   * Set by the gateway per session: the session's user is a member of the household the
+   * handover is about — the home's residents while it is not vacated, the departing household
+   * (VACANCY) while it is. Someone who is both staff and in that household is told both, so a
+   * client offers them the household's export, and with recipient_household_admin its
+   * confirmation, as well as what staff may do, rather than guessing from roles which of the
+   * two they are.
+   *
+   * @generated from field: bool recipient_in_household = 11;
+   */
+  recipientInHousehold: boolean;
+
+  /**
+   * Set by the gateway per session: the session's user may confirm the handover as a household
+   * admin — a household admin of the home now, or, for a vacated one, one of the departing
+   * household's admins (VACANCY). A client offers confirmation on this, not on
+   * recipient_in_household, which a plain resident holds too.
+   *
+   * @generated from field: bool recipient_household_admin = 12;
+   */
+  recipientHouseholdAdmin: boolean;
+
+  /**
+   * Set whenever a handover is or becomes vacated, from the push that tells it so — one started
+   * vacated, or a pending one the last residency ending makes vacated (VACANCY): a new resident
+   * filed by staff may end it early, no sooner than 24 hours after the last residency ended
+   * (QUICK TURNOVER), so the departing household's export window runs until
+   * staff_confirmable_from or until then, whichever is first. An app says so
+   * from this field rather than from vacated, so that a handover from a gateway that predates
+   * it, which ends no notice early, is not misdescribed.
+   *
+   * @generated from field: bool may_end_on_move_in = 13;
+   */
+  mayEndOnMoveIn: boolean;
+
+  /**
+   * Set on a vacated handover done early because the property owner or a gateway administrator
+   * filed a new resident (QUICK TURNOVER); ended_at says when. Unset on every other.
+   *
+   * @generated from field: bool ended_by_move_in = 14;
+   */
+  endedByMoveIn: boolean;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.HouseholdHandover.
+ * Use `create(HouseholdHandoverSchema)` to create a new message.
+ */
+export declare const HouseholdHandoverSchema: GenMessage<HouseholdHandover>;
+
+/**
+ * Erases a home's climate history (CLIMATE HISTORY), in one step, all of it or none, and
+ * nothing else. Answered with ManagementAck once it is erased. A household admin of the home
+ * only (HOUSEHOLD ADMIN, ADMIN-LESS HOME), and so not the departing household of a vacated
+ * handover (VACANCY); anyone else is refused as NOT_ENTITLED. home_id must be an apartment
+ * (INVALID_REQUEST otherwise).
+ *
+ * All of it goes, whenever it was recorded: also what the caller may not read themselves, from
+ * before their residency. Every resident of the home loses it, not only the caller, and each is
+ * told (ClimateHistoryCleared). Nothing recorded before the clear is kept, or recorded at or
+ * after it, a late write included: room history begins again with the first bucket that starts
+ * at or after the clear, and the summary of each length with its first period that starts at or
+ * after the clear; the gateway learns its models and makes its plans afresh from what is
+ * recorded at or after it. The household's members, the home's rooms and their settings, its
+ * modes, its commissioning and its heating records stay. It cannot be undone, and the gateway
+ * keeps no copy: an app asks its user to confirm, saying that everyone in the home loses it, and
+ * offers the household's export (EXPORT) first. Later parts of an export under way give nothing
+ * that was erased.
+ *
+ * The clear is pushed as ClimateHistoryCleared to every session of the home's residents, the
+ * caller's included, before the acknowledgement.
+ *
+ * The summaries are erased for everyone they are given to, so the property owner, the gateway
+ * administrators and whoever else is given the apartment's summary as service
+ * (PrivacyDisclosure.climate_summary_period) lose its periods from before the clear too, and
+ * are given none until the first period that starts at or after it has closed.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ClearClimateHistory
+ */
+export declare type ClearClimateHistory = Message<"kusinta.iot.webrtc.v1.ClearClimateHistory"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ClearClimateHistory.
+ * Use `create(ClearClimateHistorySchema)` to create a new message.
+ */
+export declare const ClearClimateHistorySchema: GenMessage<ClearClimateHistory>;
+
+/**
+ * A home's climate history was cleared (ClearClimateHistory), pushed as
+ * GatewayMessage.climate_history_cleared to the sessions of its residents. An app drops on
+ * arrival every room history, climate summary and device event of the home it holds from before
+ * cleared_at, rather than keeping what the gateway no longer does, and keeps cleared_at as a
+ * lasting floor for the home: a sample, period or event dated before it that arrives later — an
+ * answer already in flight at the clear — is dropped on arrival too. The push is the live
+ * signal; a session that was not up for it reads the same floor from the apartment
+ * (space.v1.Space.climate_history_cleared_at). Nobody else is told: whoever is given the
+ * apartment's summary as service learns of it by reading it.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ClimateHistoryCleared
+ */
+export declare type ClimateHistoryCleared = Message<"kusinta.iot.webrtc.v1.ClimateHistoryCleared"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: google.protobuf.Timestamp cleared_at = 2;
+   */
+  clearedAt?: Timestamp | undefined;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ClimateHistoryCleared.
+ * Use `create(ClimateHistoryClearedSchema)` to create a new message.
+ */
+export declare const ClimateHistoryClearedSchema: GenMessage<ClimateHistoryCleared>;
+
+/**
+ * Sets the household's own name for its home (space.v1.Space.home_name). Answered with
+ * ManagementAck. Any resident of the home may — a name is not governance, so it is not kept to
+ * household admins; anyone else is refused as NOT_ENTITLED. home_id must be an apartment
+ * (INVALID_REQUEST otherwise). The name is trimmed; empty clears it, and one longer than 64
+ * characters is refused as INVALID_REQUEST with metadata {"reason": "home_name"}. It never
+ * changes the apartment's own name (space.v1.Space.name), and it is wiped at the home's
+ * handover.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.SetHomeName
+ */
+export declare type SetHomeName = Message<"kusinta.iot.webrtc.v1.SetHomeName"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: string name = 2;
+   */
+  name: string;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.SetHomeName.
+ * Use `create(SetHomeNameSchema)` to create a new message.
+ */
+export declare const SetHomeNameSchema: GenMessage<SetHomeName>;
+
+/**
+ * The answer to ListHouseholdHandovers.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.HouseholdHandovers
+ */
+export declare type HouseholdHandovers = Message<"kusinta.iot.webrtc.v1.HouseholdHandovers"> & {
+  /**
+   * @generated from field: repeated kusinta.iot.webrtc.v1.HouseholdHandover handovers = 1;
+   */
+  handovers: HouseholdHandover[];
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.HouseholdHandovers.
+ * Use `create(HouseholdHandoversSchema)` to create a new message.
+ */
+export declare const HouseholdHandoversSchema: GenMessage<HouseholdHandovers>;
+
+/**
+ * Asks for one part of a home's export (EXPORT), answered with a HouseholdExport. The first
+ * part is asked with no part_token, and each further one with the next_part_token of the part
+ * before, until one comes with none. The home's residents only, and during a vacated handover
+ * the departing household, holding nothing recorded after their residency ended (VACANCY);
+ * anyone else is refused as NOT_ENTITLED.
+ *
+ * A part_token says where the next part starts. The gateway keeps nothing for it: it checks
+ * the token it minted when it is used, against the caller's rights then, so an interrupted
+ * export resumes where it stopped, within the caller's residency. A token the gateway did not
+ * mint, or minted for another caller, home or residency — one that has ended included, save
+ * during that home's vacated handover — is refused as INVALID_REQUEST with metadata
+ * {"reason": "part_token"}.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.ExportHouseholdData
+ */
+export declare type ExportHouseholdData = Message<"kusinta.iot.webrtc.v1.ExportHouseholdData"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+
+  /**
+   * @generated from field: string part_token = 2;
+   */
+  partToken: string;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ExportHouseholdData.
+ * Use `create(ExportHouseholdDataSchema)` to create a new message.
+ */
+export declare const ExportHouseholdDataSchema: GenMessage<ExportHouseholdData>;
+
+/**
+ * One part of a home's export (EXPORT). The gateway chooses the order of the parts and how
+ * each is cut; together they are the whole of it, each as of when it was made. Each part is
+ * what the read named beside it would give the caller.
+ *
+ * @generated from message kusinta.iot.webrtc.v1.HouseholdExport
+ */
+export declare type HouseholdExport = Message<"kusinta.iot.webrtc.v1.HouseholdExport"> & {
+  /**
+   * @generated from field: kusinta.iot.identity.v1.SpaceId home_id = 1;
+   */
+  homeId?: SpaceId | undefined;
+
+  /**
+   * @generated from oneof kusinta.iot.webrtc.v1.HouseholdExport.part
+   */
+  part: {
+    /**
+     * The home's rooms, their settings, and the modes on the home (ListRoomClimates).
+     *
+     * @generated from field: kusinta.iot.climate.v1.RoomClimateList room_climates = 2;
+     */
+    value: RoomClimateList;
+    case: "roomClimates";
+  } | {
+    /**
+     * One room's history at one resolution, one GetRoomHistory answer's worth. A room's history
+     * comes at the finest resolution held for each stretch of time, with no time given twice:
+     * at the finest resolution the gateway gives, from its kept_from; at each coarser one, the
+     * buckets from its kept_from that end at or before the next finer one's kept_from. In as
+     * many parts as it takes.
+     *
+     * @generated from field: kusinta.iot.climate.v1.RoomHistory room_history = 3;
+     */
+    value: RoomHistory;
+    case: "roomHistory";
+  } | {
+    /**
+     * The home's climate summary over one period length (GetApartmentClimateSummary): one
+     * part for each of DAY, WEEK and MONTH.
+     *
+     * @generated from field: kusinta.iot.climate.v1.ApartmentClimateSummary climate_summary = 4;
+     */
+    value: ApartmentClimateSummary;
+    case: "climateSummary";
+  } | {
+    /**
+     * The home's commissioning (ListCommissioning).
+     *
+     * @generated from field: kusinta.iot.commissioning.v1.CommissioningProfile commissioning = 5;
+     */
+    value: CommissioningProfile;
+    case: "commissioning";
+  } | {
+    /**
+     * The home's heating records (ListHeating).
+     *
+     * @generated from field: kusinta.iot.heating.v1.HeatingLayout heating = 6;
+     */
+    value: HeatingLayout;
+    case: "heating";
+  } | { case: undefined; value?: undefined };
+
+  /**
+   * The token to ask for the next part with; empty on the last.
+   *
+   * @generated from field: string next_part_token = 7;
+   */
+  nextPartToken: string;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.HouseholdExport.
+ * Use `create(HouseholdExportSchema)` to create a new message.
+ */
+export declare const HouseholdExportSchema: GenMessage<HouseholdExport>;
+
+/**
+ * How a staff member appointed a household admin (STAFF APPOINTMENT).
+ *
+ * @generated from enum kusinta.iot.webrtc.v1.StaffAppointmentKind
+ */
+export enum StaffAppointmentKind {
+  /**
+   * @generated from enum value: STAFF_APPOINTMENT_KIND_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * An appointment invite on an empty home, redeemed.
+   *
+   * @generated from enum value: STAFF_APPOINTMENT_KIND_INVITE = 1;
+   */
+  INVITE = 1,
+
+  /**
+   * A promotion request to a resident of an admin-less home, accepted.
+   *
+   * @generated from enum value: STAFF_APPOINTMENT_KIND_PROMOTION = 2;
+   */
+  PROMOTION = 2,
+}
+
+/**
+ * Describes the enum kusinta.iot.webrtc.v1.StaffAppointmentKind.
+ */
+export declare const StaffAppointmentKindSchema: GenEnum<StaffAppointmentKind>;
+
+/**
+ * @generated from enum kusinta.iot.webrtc.v1.HouseholdHandoverState
+ */
+export enum HouseholdHandoverState {
+  /**
+   * A state this schema does not know: read as PENDING.
+   *
+   * @generated from enum value: HOUSEHOLD_HANDOVER_STATE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * @generated from enum value: HOUSEHOLD_HANDOVER_STATE_PENDING = 1;
+   */
+  PENDING = 1,
+
+  /**
+   * @generated from enum value: HOUSEHOLD_HANDOVER_STATE_CANCELLED = 2;
+   */
+  CANCELLED = 2,
+
+  /**
+   * Confirmed, or, for a vacated one, its notice passed with nobody living in the home or a new
+   * resident filed (QUICK TURNOVER); the wipe has run. The last residency ending while one is
+   * pending makes it vacated, not done (VACANCY).
+   *
+   * @generated from enum value: HOUSEHOLD_HANDOVER_STATE_DONE = 3;
+   */
+  DONE = 3,
+}
+
+/**
+ * Describes the enum kusinta.iot.webrtc.v1.HouseholdHandoverState.
+ */
+export declare const HouseholdHandoverStateSchema: GenEnum<HouseholdHandoverState>;
+