@kusinta/iot-schema 0.2.0-beta.40 → 0.2.0-beta.41

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

@@ -0,0 +1,490 @@
+// @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.
+   * 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 nobody new
+   * moves in (VACANCY).
+   *
+   * @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;
+};
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.HouseholdHandover.
+ * Use `create(HouseholdHandoverSchema)` to create a new message.
+ */
+export declare const HouseholdHandoverSchema: GenMessage<HouseholdHandover>;
+
+/**
+ * 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 over at most 7 days of buckets, as GetRoomHistory answers it. A
+     * room's history comes in as many parts as it takes, in order.
+     *
+     * @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 the last residency of the home ended while it was pending.
+   *
+   * @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>;
+

package/src/kusinta/iot/webrtc/v1/household_pb.js

@@ -0,0 +1,120 @@
+// @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 { enumDesc, fileDesc, messageDesc, tsEnum } from "@bufbuild/protobuf/codegenv2";
+import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import { file_kusinta_iot_climate_v1_climate } from "../../climate/v1/climate_pb.js";
+import { file_kusinta_iot_commissioning_v1_commissioning } from "../../commissioning/v1/commissioning_pb.js";
+import { file_kusinta_iot_heating_v1_heating } from "../../heating/v1/heating_pb.js";
+import { file_kusinta_iot_identity_v1_identity } from "../../identity/v1/identity_pb.js";
+
+/**
+ * Describes the file kusinta/iot/webrtc/v1/household.proto.
+ */
+export const file_kusinta_iot_webrtc_v1_household = /*@__PURE__*/
+  fileDesc("CiVrdXNpbnRhL2lvdC93ZWJydGMvdjEvaG91c2Vob2xkLnByb3RvEhVrdXNpbnRhLmlvdC53ZWJydGMudjEiewoURGVtb3RlSG91c2Vob2xkQWRtaW4SMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQSMAoHdXNlcl9pZBgCIAEoCzIfLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlVzZXJJZCL7AQoQU3RhZmZBcHBvaW50bWVudBIyCglhcHBvaW50ZWUYASABKAsyHy5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5Vc2VySWQSNQoMYXBwb2ludGVkX2J5GAIgASgLMh8ua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuVXNlcklkEhkKEWFwcG9pbnRlZF9ieV9uYW1lGAMgASgJEiYKAmF0GAQgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBI5CgRraW5kGAUgASgOMisua3VzaW50YS5pb3Qud2VicnRjLnYxLlN0YWZmQXBwb2ludG1lbnRLaW5kIksKFlN0YXJ0SG91c2Vob2xkSGFuZG92ZXISMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQiLwoYQ29uZmlybUhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJIi4KF0NhbmNlbEhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJIlEKFkxpc3RIb3VzZWhvbGRIYW5kb3ZlcnMSNwoNcm9vdF9zcGFjZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQirAMKEUhvdXNlaG9sZEhhbmRvdmVyEhMKC2hhbmRvdmVyX2lkGAEgASgJEjEKB2hvbWVfaWQYAiABKAsyIC5rdXNpbnRhLmlvdC5pZGVudGl0eS52MS5TcGFjZUlkEjwKBXN0YXRlGAMgASgOMi0ua3VzaW50YS5pb3Qud2VicnRjLnYxLkhvdXNlaG9sZEhhbmRvdmVyU3RhdGUSMwoKc3RhcnRlZF9ieRgEIAEoCzIfLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlVzZXJJZBIXCg9zdGFydGVkX2J5X25hbWUYBSABKAkSGAoQc3RhcnRlZF9ieV9zdGFmZhgGIAEoCBIuCgpzdGFydGVkX2F0GAcgASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBI6ChZzdGFmZl9jb25maXJtYWJsZV9mcm9tGAggASgLMhouZ29vZ2xlLnByb3RvYnVmLlRpbWVzdGFtcBIsCghlbmRlZF9hdBgJIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASDwoHdmFjYXRlZBgKIAEoCCJOCgtTZXRIb21lTmFtZRIxCgdob21lX2lkGAEgASgLMiAua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuU3BhY2VJZBIMCgRuYW1lGAIgASgJIlEKEkhvdXNlaG9sZEhhbmRvdmVycxI7CgloYW5kb3ZlcnMYASADKAsyKC5rdXNpbnRhLmlvdC53ZWJydGMudjEuSG91c2Vob2xkSGFuZG92ZXIiXAoTRXhwb3J0SG91c2Vob2xkRGF0YRIxCgdob21lX2lkGAEgASgLMiAua3VzaW50YS5pb3QuaWRlbnRpdHkudjEuU3BhY2VJZBISCgpwYXJ0X3Rva2VuGAIgASgJIrcDCg9Ib3VzZWhvbGRFeHBvcnQSMQoHaG9tZV9pZBgBIAEoCzIgLmt1c2ludGEuaW90LmlkZW50aXR5LnYxLlNwYWNlSWQSQAoNcm9vbV9jbGltYXRlcxgCIAEoCzInLmt1c2ludGEuaW90LmNsaW1hdGUudjEuUm9vbUNsaW1hdGVMaXN0SAASOwoMcm9vbV9oaXN0b3J5GAMgASgLMiMua3VzaW50YS5pb3QuY2xpbWF0ZS52MS5Sb29tSGlzdG9yeUgAEkoKD2NsaW1hdGVfc3VtbWFyeRgEIAEoCzIvLmt1c2ludGEuaW90LmNsaW1hdGUudjEuQXBhcnRtZW50Q2xpbWF0ZVN1bW1hcnlIABJLCg1jb21taXNzaW9uaW5nGAUgASgLMjIua3VzaW50YS5pb3QuY29tbWlzc2lvbmluZy52MS5Db21taXNzaW9uaW5nUHJvZmlsZUgAEjgKB2hlYXRpbmcYBiABKAsyJS5rdXNpbnRhLmlvdC5oZWF0aW5nLnYxLkhlYXRpbmdMYXlvdXRIABIXCg9uZXh0X3BhcnRfdG9rZW4YByABKAlCBgoEcGFydCqHAQoUU3RhZmZBcHBvaW50bWVudEtpbmQSJgoiU1RBRkZfQVBQT0lOVE1FTlRfS0lORF9VTlNQRUNJRklFRBAAEiEKHVNUQUZGX0FQUE9JTlRNRU5UX0tJTkRfSU5WSVRFEAESJAogU1RBRkZfQVBQT0lOVE1FTlRfS0lORF9QUk9NT1RJT04QAiqzAQoWSG91c2Vob2xkSGFuZG92ZXJTdGF0ZRIoCiRIT1VTRUhPTERfSEFORE9WRVJfU1RBVEVfVU5TUEVDSUZJRUQQABIkCiBIT1VTRUhPTERfSEFORE9WRVJfU1RBVEVfUEVORElORxABEiYKIkhPVVNFSE9MRF9IQU5ET1ZFUl9TVEFURV9DQU5DRUxMRUQQAhIhCh1IT1VTRUhPTERfSEFORE9WRVJfU1RBVEVfRE9ORRADQgJIAWIGcHJvdG8z", [file_google_protobuf_timestamp, file_kusinta_iot_climate_v1_climate, file_kusinta_iot_commissioning_v1_commissioning, file_kusinta_iot_heating_v1_heating, file_kusinta_iot_identity_v1_identity]);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.DemoteHouseholdAdmin.
+ * Use `create(DemoteHouseholdAdminSchema)` to create a new message.
+ */
+export const DemoteHouseholdAdminSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 0);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.StaffAppointment.
+ * Use `create(StaffAppointmentSchema)` to create a new message.
+ */
+export const StaffAppointmentSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 1);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.StartHouseholdHandover.
+ * Use `create(StartHouseholdHandoverSchema)` to create a new message.
+ */
+export const StartHouseholdHandoverSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 2);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ConfirmHouseholdHandover.
+ * Use `create(ConfirmHouseholdHandoverSchema)` to create a new message.
+ */
+export const ConfirmHouseholdHandoverSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 3);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.CancelHouseholdHandover.
+ * Use `create(CancelHouseholdHandoverSchema)` to create a new message.
+ */
+export const CancelHouseholdHandoverSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 4);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ListHouseholdHandovers.
+ * Use `create(ListHouseholdHandoversSchema)` to create a new message.
+ */
+export const ListHouseholdHandoversSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 5);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.HouseholdHandover.
+ * Use `create(HouseholdHandoverSchema)` to create a new message.
+ */
+export const HouseholdHandoverSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 6);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.SetHomeName.
+ * Use `create(SetHomeNameSchema)` to create a new message.
+ */
+export const SetHomeNameSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 7);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.HouseholdHandovers.
+ * Use `create(HouseholdHandoversSchema)` to create a new message.
+ */
+export const HouseholdHandoversSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 8);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.ExportHouseholdData.
+ * Use `create(ExportHouseholdDataSchema)` to create a new message.
+ */
+export const ExportHouseholdDataSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 9);
+
+/**
+ * Describes the message kusinta.iot.webrtc.v1.HouseholdExport.
+ * Use `create(HouseholdExportSchema)` to create a new message.
+ */
+export const HouseholdExportSchema = /*@__PURE__*/
+  messageDesc(file_kusinta_iot_webrtc_v1_household, 10);
+
+/**
+ * Describes the enum kusinta.iot.webrtc.v1.StaffAppointmentKind.
+ */
+export const StaffAppointmentKindSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_webrtc_v1_household, 0);
+
+/**
+ * How a staff member appointed a household admin (STAFF APPOINTMENT).
+ *
+ * @generated from enum kusinta.iot.webrtc.v1.StaffAppointmentKind
+ */
+export const StaffAppointmentKind = /*@__PURE__*/
+  tsEnum(StaffAppointmentKindSchema);
+
+/**
+ * Describes the enum kusinta.iot.webrtc.v1.HouseholdHandoverState.
+ */
+export const HouseholdHandoverStateSchema = /*@__PURE__*/
+  enumDesc(file_kusinta_iot_webrtc_v1_household, 1);
+
+/**
+ * @generated from enum kusinta.iot.webrtc.v1.HouseholdHandoverState
+ */
+export const HouseholdHandoverState = /*@__PURE__*/
+  tsEnum(HouseholdHandoverStateSchema);
+

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

@@ -16,21 +16,25 @@ export declare const file_kusinta_iot_webrtc_v1_invite: GenFile;
 /**
  * Creates an invite on a space.
  *
- * relation is RESIDENT or SERVICE and nothing else, and it decides the role the person
- * will hold: a resident for RESIDENT, a technician for SERVICE. RESIDENT is refused
- * anywhere but a home (access.v1.MembershipRelation). No invite ever makes anyone a
- * gateway administrator or a property owner: those come only by promotion of someone
- * already a member, and any other relation is refused as INVALID_REQUEST.
+ * relation is RESIDENT, SERVICE or HOUSEHOLD_ADMIN and nothing else, and it decides the role
+ * the person will hold: a resident for RESIDENT and HOUSEHOLD_ADMIN, a technician for SERVICE.
+ * RESIDENT is refused anywhere but a home (access.v1.MembershipRelation). HOUSEHOLD_ADMIN is
+ * a staff appointment, from a caller holding ROLE_PROPERTY_OWNER or ROLE_GATEWAY_ADMIN, on an
+ * empty home only, and refused as household.proto (STAFF APPOINTMENT) says; it never takes
+ * access_until. It must be bound to an address: one with no email is refused as
+ * INVALID_REQUEST with metadata {"reason": "email_required"}, and is never made a home key. No invite ever makes anyone a gateway administrator or a property owner:
+ * those come only by promotion of someone already a member, and any other relation is refused
+ * as INVALID_REQUEST.
  *
  * Who may create one is the gateway's decision, as for AssignUserToSpace. The gateway may
- * let a home's residents invite residents into their own home only, within a limit per
- * home. A caller over that limit is refused as FAILED_PRECONDITION with metadata
- * {"reason": "household_full"}.
+ * let a home's household admins invite residents into their own home only, within a limit per
+ * home; a resident who is not a household admin may not (household.proto). A caller over that
+ * limit is refused as FAILED_PRECONDITION with metadata {"reason": "household_full"}.
  *
  * Whether a RESIDENT invite with no address is a home key or a household invite (see the
  * file header) is decided by who creates it, never asked for: a home key when the caller
  * holds ROLE_PROPERTY_OWNER or ROLE_GATEWAY_ADMIN, whether or not they live in the home; a
- * household invite when the caller creates it as a resident of the home.
+ * household invite when the caller creates it as a household admin of the home.
  *
  * A gateway holds at most 5000 invites whose secrets it reports
  * (reporting.v1.ReportInviteRoutesRequest), used ones included until their secrets
@@ -154,11 +158,11 @@ export declare const MarkInviteEmailSentSchema: GenMessage<MarkInviteEmailSent>;
 /**
  * The pending invites and join requests of a space. Answered with SpaceInvites. Listed
  * only to a caller who may create invites on the space; anyone else is refused as
- * NOT_ENTITLED. A resident is listed only the invites a resident of their home made,
+ * NOT_ENTITLED. A household admin is listed only the invites a resident of their home made,
  * and the join requests those made: nothing they cannot act on.
  *
- * A household invite, and the join requests it made, are listed only to the residents of
- * that home, a property owner or an administrator included only if they live there:
+ * A household invite, and the join requests it made, are listed only to the household admins
+ * of that home, a property owner or an administrator included only if they live there:
  * otherwise Invite.created_by and JoinRequest.invited_by would say where its maker lives.
  *
  * @generated from message kusinta.iot.webrtc.v1.ListSpaceInvites
@@ -181,8 +185,8 @@ export declare const ListSpaceInvitesSchema: GenMessage<ListSpaceInvites>;
  * that relation gives. Answered with ManagementAck.
  *
  * Who may approve is the gateway's decision, by the kind of invite the request came from
- * (see the file header): for a household invite, a resident of that home alone, and not a
- * property owner or an administrator who does not live there; for a SERVICE invite with no
+ * (see the file header): for a household invite, a household admin of that home alone, and
+ * not a property owner or an administrator who does not live there; for a SERVICE invite with no
  * address, whoever may put people on that space. Anyone else is refused as NOT_ENTITLED.
  *
  * @generated from message kusinta.iot.webrtc.v1.ApproveJoinRequest
@@ -425,7 +429,7 @@ export declare const JoinRequestSchema: GenMessage<JoinRequest>;
  * every session that may list it, so the app shows the change without reloading. A push
  * always carries the whole of both lists for its space, as ListSpaceInvites would list
  * them to that session: a household invite and its join requests reach only the sessions
- * of that home's residents.
+ * of that home's household admins.
  *
  * @generated from message kusinta.iot.webrtc.v1.SpaceInvites
  */