@kusinta/iot-schema 0.2.0-beta.3 → 0.2.0-beta.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/package.json +9 -1
  2. package/src/kusinta/iot/access/v1/acl_pb.d.ts +118 -2
  3. package/src/kusinta/iot/access/v1/acl_pb.js +20 -3
  4. package/src/kusinta/iot/access/v1/roles_pb.d.ts +119 -4
  5. package/src/kusinta/iot/access/v1/roles_pb.js +98 -5
  6. package/src/kusinta/iot/climate/v1/climate_pb.d.ts +726 -0
  7. package/src/kusinta/iot/climate/v1/climate_pb.js +142 -0
  8. package/src/kusinta/iot/common/v1/pairing_pb.d.ts +217 -0
  9. package/src/kusinta/iot/common/v1/pairing_pb.js +50 -0
  10. package/src/kusinta/iot/common/v1/types_pb.d.ts +175 -0
  11. package/src/kusinta/iot/common/v1/types_pb.js +70 -1
  12. package/src/kusinta/iot/connector/v1/connector_pb.d.ts +691 -2
  13. package/src/kusinta/iot/connector/v1/connector_pb.js +104 -13
  14. package/src/kusinta/iot/device/v1/cluster_state_pb.d.ts +44 -0
  15. package/src/kusinta/iot/device/v1/cluster_state_pb.js +1 -1
  16. package/src/kusinta/iot/device/v1/descriptor_pb.d.ts +22 -2
  17. package/src/kusinta/iot/device/v1/descriptor_pb.js +2 -1
  18. package/src/kusinta/iot/device/v1/device_event_pb.d.ts +87 -5
  19. package/src/kusinta/iot/device/v1/device_event_pb.js +1 -1
  20. package/src/kusinta/iot/device/v1/device_pb.d.ts +150 -6
  21. package/src/kusinta/iot/device/v1/device_pb.js +33 -2
  22. package/src/kusinta/iot/device/v1/matter_options_pb.d.ts +26 -0
  23. package/src/kusinta/iot/device/v1/matter_options_pb.js +31 -4
  24. package/src/kusinta/iot/device/v1/properties_pb.d.ts +14 -0
  25. package/src/kusinta/iot/device/v1/properties_pb.js +1 -1
  26. package/src/kusinta/iot/device/v1/property_update_pb.d.ts +3 -2
  27. package/src/kusinta/iot/link/v1/link_pb.d.ts +438 -0
  28. package/src/kusinta/iot/link/v1/link_pb.js +121 -0
  29. package/src/kusinta/iot/reporting/v1/reporting_pb.d.ts +1219 -0
  30. package/src/kusinta/iot/reporting/v1/reporting_pb.js +238 -0
  31. package/src/kusinta/iot/reporting/v1/reporting_service_pb.d.ts +63 -0
  32. package/src/kusinta/iot/reporting/v1/reporting_service_pb.js +24 -0
  33. package/src/kusinta/iot/signaling/v1/signaling_pb.d.ts +361 -7
  34. package/src/kusinta/iot/signaling/v1/signaling_pb.js +68 -4
  35. package/src/kusinta/iot/signaling/v1/signaling_service_pb.d.ts +24 -1
  36. package/src/kusinta/iot/signaling/v1/signaling_service_pb.js +1 -1
  37. package/src/kusinta/iot/space/v1/space_pb.d.ts +103 -2
  38. package/src/kusinta/iot/space/v1/space_pb.js +10 -1
  39. package/src/kusinta/iot/vendor/homematic/v1/homematic_pb.d.ts +162 -13
  40. package/src/kusinta/iot/vendor/homematic/v1/homematic_pb.js +8 -1
  41. package/src/kusinta/iot/vendor/lorawan/v1/lorawan_pb.d.ts +69 -0
  42. package/src/kusinta/iot/vendor/lorawan/v1/lorawan_pb.js +19 -0
  43. package/src/kusinta/iot/vendor/v1/vendor_options_pb.d.ts +25 -4
  44. package/src/kusinta/iot/vendor/v1/vendor_options_pb.js +28 -6
  45. package/src/kusinta/iot/webrtc/v1/app_token_pb.d.ts +45 -5
  46. package/src/kusinta/iot/webrtc/v1/app_token_pb.js +1 -1
  47. package/src/kusinta/iot/webrtc/v1/command_pb.d.ts +14 -0
  48. package/src/kusinta/iot/webrtc/v1/command_pb.js +1 -1
  49. package/src/kusinta/iot/webrtc/v1/device_state_pb.d.ts +179 -5
  50. package/src/kusinta/iot/webrtc/v1/device_state_pb.js +35 -6
  51. package/src/kusinta/iot/webrtc/v1/envelope_pb.d.ts +520 -3
  52. package/src/kusinta/iot/webrtc/v1/envelope_pb.js +65 -3
  53. package/src/kusinta/iot/webrtc/v1/invite_pb.d.ts +498 -0
  54. package/src/kusinta/iot/webrtc/v1/invite_pb.js +108 -0
  55. package/src/kusinta/iot/webrtc/v1/management_pb.d.ts +982 -12
  56. package/src/kusinta/iot/webrtc/v1/management_pb.js +132 -5
  57. package/src/kusinta/iot/webrtc/v1/members_pb.d.ts +328 -0
  58. package/src/kusinta/iot/webrtc/v1/members_pb.js +78 -0
  59. package/src/kusinta/iot/webrtc/v1/permission_push_pb.d.ts +66 -4
  60. package/src/kusinta/iot/webrtc/v1/permission_push_pb.js +10 -2
@@ -5,8 +5,16 @@
5
5
  import type { GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
6
6
  import type { Message } from "@bufbuild/protobuf";
7
7
  import type { DeviceOwnershipType, SpaceType } from "../../common/v1/types_pb.js";
8
- import type { DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
8
+ import type { ConnectorId, DeviceId, SpaceId, UserId } from "../../identity/v1/identity_pb.js";
9
+ import type { MembershipRelation, Role } from "../../access/v1/roles_pb.js";
10
+ import type { LorawanProvisioning } from "../../vendor/lorawan/v1/lorawan_pb.js";
9
11
  import type { Space } from "../../space/v1/space_pb.js";
12
+ import type { LinkFunction, LinkMode, LinkSettings } from "../../link/v1/link_pb.js";
13
+ import type { ClimateModeKind, ClimateSummaryPeriod } from "../../climate/v1/climate_pb.js";
14
+ import type { Timestamp } from "@bufbuild/protobuf/wkt";
15
+ import type { ServiceSignal } from "../../access/v1/acl_pb.js";
16
+ import type { ApproveJoinRequest, CreateInvite, DenyJoinRequest, ListSpaceInvites, MarkInviteEmailSent, ResendInvite, RevokeInvite } from "./invite_pb.js";
17
+ import type { ListGatewayMembers, RemoveFromGateway, SetAccessUntil, SetMemberRole, SetOwnerOrganisation } from "./members_pb.js";
10
18
 
11
19
  /**
12
20
  * Describes the file kusinta/iot/webrtc/v1/management.proto.
@@ -18,6 +26,10 @@ export declare const file_kusinta_iot_webrtc_v1_management: GenFile;
18
26
  * stronger request than it looks: there is no parent whose reach could authorize
19
27
  * it, so it is reserved to the gateway's administrator.
20
28
  *
29
+ * Under an apartment only a room may be created. Creating in a home is guarded as
30
+ * UpdateSpace is, and refused whatever the caller where UpdateSpace's structure rules would
31
+ * refuse it.
32
+ *
21
33
  * @generated from message kusinta.iot.webrtc.v1.CreateSpace
22
34
  */
23
35
  export declare type CreateSpace = Message<"kusinta.iot.webrtc.v1.CreateSpace"> & {
@@ -49,6 +61,14 @@ export declare type CreateSpace = Message<"kusinta.iot.webrtc.v1.CreateSpace"> &
49
61
  * @generated from field: kusinta.iot.identity.v1.SpaceId parent_space_id = 5;
50
62
  */
51
63
  parentSpaceId?: SpaceId | undefined;
64
+
65
+ /**
66
+ * An IANA time zone name, e.g. "Europe/Stockholm". Accepted only on a building — a
67
+ * top-level space — and refused on any other. Unset leaves it unknown.
68
+ *
69
+ * @generated from field: optional string time_zone = 6;
70
+ */
71
+ timeZone?: string | undefined;
52
72
  };
53
73
 
54
74
  /**
@@ -58,9 +78,21 @@ export declare type CreateSpace = Message<"kusinta.iot.webrtc.v1.CreateSpace"> &
58
78
  export declare const CreateSpaceSchema: GenMessage<CreateSpace>;
59
79
 
60
80
  /**
61
- * Changes a space in place. Every descriptive field carries explicit presence:
62
- * absent means leave it alone, present means set it to this — including to the
63
- * empty string, which is how a description is cleared.
81
+ * Changes a space in place. Changes that would take a space into or out of a home, or move
82
+ * a home, are guarded by the gateway; a caller not allowed is refused as NOT_ENTITLED. A
83
+ * change is refused whatever the caller if it would leave anything but a room under an
84
+ * apartment, an apartment in a home, or — among what the caller can see — a device in two
85
+ * homes or a link across a home's boundary. What the caller cannot see never refuses it: a
86
+ * device a resident owns that would leave its owner's home, enter a home not theirs or sit
87
+ * in two homes is taken out of the moving space instead — staying in its owner's home,
88
+ * filed on the apartment, where it was in it — and any link it would carry across a
89
+ * boundary is removed. Changing the type of a space that has members needs
90
+ * ROLE_PROPERTY_OWNER or ROLE_GATEWAY_ADMIN, who see them, and is refused if it would
91
+ * leave a RESIDENT membership on a room.
92
+ *
93
+ * Every descriptive field carries explicit presence: absent means leave it alone, present
94
+ * means set it to this — including to the empty string, which is how a description is
95
+ * cleared.
64
96
  *
65
97
  * @generated from message kusinta.iot.webrtc.v1.UpdateSpace
66
98
  */
@@ -111,6 +143,15 @@ export declare type UpdateSpace = Message<"kusinta.iot.webrtc.v1.UpdateSpace"> &
111
143
  value: boolean;
112
144
  case: "detach";
113
145
  } | { case: undefined; value?: undefined };
146
+
147
+ /**
148
+ * An IANA time zone name, e.g. "Europe/Stockholm". Accepted only on a building — a
149
+ * top-level space — and refused on any other. Unset leaves it unchanged; the empty
150
+ * string clears it.
151
+ *
152
+ * @generated from field: optional string time_zone = 8;
153
+ */
154
+ timeZone?: string | undefined;
114
155
  };
115
156
 
116
157
  /**
@@ -122,7 +163,8 @@ export declare const UpdateSpaceSchema: GenMessage<UpdateSpace>;
122
163
  /**
123
164
  * Deletes a space. Refused if the space still holds devices or sub-spaces unless
124
165
  * cascade is set, so that emptying a building is always something the caller
125
- * asked for rather than something a stale client did by accident.
166
+ * asked for rather than something a stale client did by accident. Deleting a home, or
167
+ * anything in one, is guarded as UpdateSpace is.
126
168
  *
127
169
  * @generated from message kusinta.iot.webrtc.v1.DeleteSpace
128
170
  */
@@ -145,10 +187,21 @@ export declare type DeleteSpace = Message<"kusinta.iot.webrtc.v1.DeleteSpace"> &
145
187
  export declare const DeleteSpaceSchema: GenMessage<DeleteSpace>;
146
188
 
147
189
  /**
148
- * Adds a user to a space, granting them reach of it and everything beneath it.
190
+ * Adds a user to a space, granting them reach of it and everything beneath it — except
191
+ * that a RESIDENT membership reaches no home beneath it (see access.v1.MembershipRelation).
149
192
  * The user need not be known to the gateway beforehand — identities are minted by
150
193
  * the token issuer, and this records that one of them belongs here.
151
194
  *
195
+ * Assigning a user who is already a member changes their relation to the space.
196
+ * RESIDENT is refused on a room; see access.v1.MembershipRelation.
197
+ *
198
+ * Who may change who belongs to a home is restricted by the gateway; a caller not allowed is
199
+ * refused as NOT_ENTITLED. Residents see who is filed on their home in Space.members.
200
+ *
201
+ * A membership the caller is not told of (a staff member's residency, to anyone outside
202
+ * its household: access.v1.Role, STAFF) is never changed by them: assigning onto it is
203
+ * refused as NOT_ENTITLED, and RemoveUserFromSpace answers as for one that does not exist.
204
+ *
152
205
  * @generated from message kusinta.iot.webrtc.v1.AssignUserToSpace
153
206
  */
154
207
  export declare type AssignUserToSpace = Message<"kusinta.iot.webrtc.v1.AssignUserToSpace"> & {
@@ -161,6 +214,15 @@ export declare type AssignUserToSpace = Message<"kusinta.iot.webrtc.v1.AssignUse
161
214
  * @generated from field: kusinta.iot.identity.v1.UserId user_id = 2;
162
215
  */
163
216
  userId?: UserId | undefined;
217
+
218
+ /**
219
+ * How the user stands to the space — whether they live there or are there for the
220
+ * building. Required: UNSPECIFIED is refused, never defaulted. See
221
+ * access.v1.MembershipRelation for what each lets a member see of a home.
222
+ *
223
+ * @generated from field: kusinta.iot.access.v1.MembershipRelation relation = 4;
224
+ */
225
+ relation: MembershipRelation;
164
226
  };
165
227
 
166
228
  /**
@@ -173,6 +235,9 @@ export declare const AssignUserToSpaceSchema: GenMessage<AssignUserToSpace>;
173
235
  * Removes a user's membership of a space. Losing reach also drops whatever the
174
236
  * user was streaming from it, announced by LivePermissionUpdate.
175
237
  *
238
+ * Removing someone else from a home is guarded as assigning is. A membership the caller is
239
+ * not told of (see AssignUserToSpace) is answered as one that does not exist, and stays.
240
+ *
176
241
  * @generated from message kusinta.iot.webrtc.v1.RemoveUserFromSpace
177
242
  */
178
243
  export declare type RemoveUserFromSpace = Message<"kusinta.iot.webrtc.v1.RemoveUserFromSpace"> & {
@@ -197,6 +262,12 @@ export declare const RemoveUserFromSpaceSchema: GenMessage<RemoveUserFromSpace>;
197
262
  * Files a device into a space. A device may sit in several spaces at once; this
198
263
  * is additive, and filing a device where it already sits is a no-op.
199
264
  *
265
+ * Into a home go only the building's own devices and devices its residents own, and a
266
+ * device belongs to one home at most; filing into, out of or beside a home is guarded by
267
+ * the gateway. A caller not allowed is refused as NOT_ENTITLED, and filing that would leave
268
+ * a link the caller can see across a home's boundary is refused whatever the caller; one
269
+ * they cannot see is removed instead.
270
+ *
200
271
  * @generated from message kusinta.iot.webrtc.v1.PlaceDeviceInSpace
201
272
  */
202
273
  export declare type PlaceDeviceInSpace = Message<"kusinta.iot.webrtc.v1.PlaceDeviceInSpace"> & {
@@ -221,6 +292,9 @@ export declare const PlaceDeviceInSpaceSchema: GenMessage<PlaceDeviceInSpace>;
221
292
  * Takes a device out of one space, leaving any others intact. A device in no
222
293
  * space and with no owner is unfiled, and visible only to the administrator.
223
294
  *
295
+ * Taking a device out of a home is guarded as PlaceDeviceInSpace is, and removes its links
296
+ * to devices still in the home.
297
+ *
224
298
  * @generated from message kusinta.iot.webrtc.v1.RemoveDeviceFromSpace
225
299
  */
226
300
  export declare type RemoveDeviceFromSpace = Message<"kusinta.iot.webrtc.v1.RemoveDeviceFromSpace"> & {
@@ -244,7 +318,12 @@ export declare const RemoveDeviceFromSpaceSchema: GenMessage<RemoveDeviceFromSpa
244
318
  /**
245
319
  * Takes ownership of a device. Ownership is reach in its own right: an owner may
246
320
  * see and control their device whatever their gateway-wide role permits, and may
247
- * file it into spaces they belong to.
321
+ * file it into spaces they belong to, and the rooms of a home they live in — though into a
322
+ * home only if they live there (see PlaceDeviceInSpace).
323
+ *
324
+ * Only a RESIDENT claim makes the caller the owner. A COMPANY claim records that the
325
+ * building owns the device, names no person, and grants the caller no reach. Claims of a
326
+ * device in a home, or of one already claimed, are restricted by the gateway.
248
327
  *
249
328
  * @generated from message kusinta.iot.webrtc.v1.ClaimDevice
250
329
  */
@@ -265,8 +344,18 @@ export declare type ClaimDevice = Message<"kusinta.iot.webrtc.v1.ClaimDevice"> &
265
344
  initialSpaceId?: SpaceId | undefined;
266
345
 
267
346
  /**
268
- * Evidence the claimant is standing at the device: the serial printed on it,
269
- * matched against DeviceDescriptor.serial_number. Required precisely when the
347
+ * Evidence the claimant is standing at the device: the identifier printed on it,
348
+ * matched against DeviceDescriptor.serial_number.
349
+ *
350
+ * The match is by SUFFIX, because what a connector announces is not always the whole
351
+ * of what is printed and the announced value is commonly the tail of the printed one.
352
+ * Both sides are normalised first — lowercased, with whitespace and ASCII hyphens
353
+ * removed, since a label prints the value in groups and a scan does not — and the proof
354
+ * is accepted when what remains ends with the announced serial. Spelled out because two
355
+ * gateways normalising differently would accept different proofs for the same device.
356
+ *
357
+ * A serial shorter than eight characters cannot be proved at all: under a suffix rule a
358
+ * short one is proved by almost anything ending with it. Required precisely when the
270
359
  * caller cannot already reach the device, which is the ordinary case for a
271
360
  * resident claiming something they just bought — an unfiled device is invisible
272
361
  * to them, so possession is the only thing left that can distinguish them from
@@ -286,8 +375,9 @@ export declare type ClaimDevice = Message<"kusinta.iot.webrtc.v1.ClaimDevice"> &
286
375
  export declare const ClaimDeviceSchema: GenMessage<ClaimDevice>;
287
376
 
288
377
  /**
289
- * Gives up ownership. The device keeps whatever space filing it has; if it has
290
- * none it becomes unfiled.
378
+ * Gives up ownership. The device keeps whatever space filing it has, except that a device in
379
+ * a home stays filed in the home alone, as one of the building's own devices there — as
380
+ * when its owner moves out; if it has none it becomes unfiled.
291
381
  *
292
382
  * @generated from message kusinta.iot.webrtc.v1.ReleaseDevice
293
383
  */
@@ -304,6 +394,66 @@ export declare type ReleaseDevice = Message<"kusinta.iot.webrtc.v1.ReleaseDevice
304
394
  */
305
395
  export declare const ReleaseDeviceSchema: GenMessage<ReleaseDevice>;
306
396
 
397
+ /**
398
+ * Registers a device with the system that will admit it, so that it can join
399
+ * later. For a technology where a device is enrolled as a record rather than
400
+ * adopted during a window — see common.v1.PairingWindow for the other case, where
401
+ * something joins a hub during a window and the arrival is attributed to the
402
+ * caller. A LoRaWAN device has no window: it is written into a network server and
403
+ * joins whenever it is next powered, which may be minutes, days, or never.
404
+ *
405
+ * Answered with the ordinary ManagementAck. A provision writes a record and returns
406
+ * nothing to show; the device itself is announced by device_added if and when it
407
+ * joins, the same path every other device takes — which is why this adds no
408
+ * ManagementResult arm. A new result arm is a compile error in a consumer that
409
+ * matches the result exhaustively; a new request arm is not.
410
+ *
411
+ * Registering and owning stay two operations. ClaimDevice records the caller and
412
+ * carries possession_proof, so a device that has not joined yet is still claimable
413
+ * by whoever holds it — and because the connector derives the device id and the
414
+ * serial from the identifier here, that claim can be made before the join.
415
+ *
416
+ * Provisioning the same identifier twice is an upsert: it replaces the credentials
417
+ * rather than being refused as a conflict, so correcting a mistyped key does not
418
+ * require removing the device first. Removing a record is a distinct act from
419
+ * giving up ownership (ReleaseDevice) and is left to a later operation.
420
+ *
421
+ * @generated from message kusinta.iot.webrtc.v1.ProvisionDevice
422
+ */
423
+ export declare type ProvisionDevice = Message<"kusinta.iot.webrtc.v1.ProvisionDevice"> & {
424
+ /**
425
+ * Required, unlike a pairing window's connector target. A registration is written
426
+ * to one specific registry; there is no sensible "open them all and see what
427
+ * joins". The app names it from the connector enumeration, targeting a connector
428
+ * that declares ConnectorInfo.supports_provisioning.
429
+ *
430
+ * @generated from field: kusinta.iot.identity.v1.ConnectorId connector_id = 1;
431
+ */
432
+ connectorId?: ConnectorId | undefined;
433
+
434
+ /**
435
+ * What the registry needs to admit the device, which differs entirely by
436
+ * technology — a oneof per technology rather than a flat set of fields, for the
437
+ * reason LinkSettings gives: the second technology to arrive must not turn this
438
+ * into a bag of unrelated optionals named after the first.
439
+ *
440
+ * @generated from oneof kusinta.iot.webrtc.v1.ProvisionDevice.credentials
441
+ */
442
+ credentials: {
443
+ /**
444
+ * @generated from field: kusinta.iot.vendor.lorawan.v1.LorawanProvisioning lorawan = 2;
445
+ */
446
+ value: LorawanProvisioning;
447
+ case: "lorawan";
448
+ } | { case: undefined; value?: undefined };
449
+ };
450
+
451
+ /**
452
+ * Describes the message kusinta.iot.webrtc.v1.ProvisionDevice.
453
+ * Use `create(ProvisionDeviceSchema)` to create a new message.
454
+ */
455
+ export declare const ProvisionDeviceSchema: GenMessage<ProvisionDevice>;
456
+
307
457
  /**
308
458
  * Asks for the spaces the caller can reach. Unset root_space_id means all of
309
459
  * them, which for most users is one apartment and for an administrator is the
@@ -333,7 +483,9 @@ export declare const ListSpacesSchema: GenMessage<ListSpaces>;
333
483
  *
334
484
  * device_ids on each Space are filtered to what the caller may see. An
335
485
  * unfiltered tree would list every device on the gateway by id, which is the
336
- * enumeration channel the snapshot filter exists to close.
486
+ * enumeration channel the snapshot filter exists to close. To a caller who sees a home as
487
+ * service, what is new in it is listed as it happens and what is gone at once, its members
488
+ * included where they are shown (see Space.members).
337
489
  *
338
490
  * @generated from message kusinta.iot.webrtc.v1.SpaceTree
339
491
  */
@@ -373,7 +525,671 @@ export declare const ManagementAckSchema: GenMessage<ManagementAck>;
373
525
  * message kind, so these can never be gated by a table keyed on the envelope case
374
526
  * the way device messages are. Keeping them behind one case means one place that
375
527
  * must authorize, and one refusal path that must not leak whether a target exists.
528
+ * Links one device to another, so the sender leads the receiver. The gateway
529
+ * resolves which underlying connections that needs and asks the connector for
530
+ * them; a caller names two devices and what the link is for.
531
+ *
532
+ * Authorized against both ends, and not symmetrically. Leading a device is a
533
+ * standing grant of control over it, so the receiver requires ownership or a
534
+ * servicing role. The sender's requirement depends on the mode: a gateway-kept
535
+ * link only reads what the caller can already see, while a device-to-device one
536
+ * writes configuration to the sender and spends its battery, which is a change
537
+ * to someone else's hardware.
538
+ *
539
+ * In a home it is the other way round: links between its devices are its residents' to
540
+ * make, change and remove, and a caller who reaches it as service is refused as
541
+ * NOT_ENTITLED. A link between a device in a home and one outside it is refused to anyone.
542
+ * The same holds for UpdateDeviceLink and RemoveDeviceLink.
543
+ *
544
+ * @generated from message kusinta.iot.webrtc.v1.CreateDeviceLink
545
+ */
546
+ export declare type CreateDeviceLink = Message<"kusinta.iot.webrtc.v1.CreateDeviceLink"> & {
547
+ /**
548
+ * @generated from field: kusinta.iot.identity.v1.DeviceId sender = 1;
549
+ */
550
+ sender?: DeviceId | undefined;
551
+
552
+ /**
553
+ * @generated from field: kusinta.iot.identity.v1.DeviceId receiver = 2;
554
+ */
555
+ receiver?: DeviceId | undefined;
556
+
557
+ /**
558
+ * @generated from field: kusinta.iot.link.v1.LinkFunction function = 3;
559
+ */
560
+ function: LinkFunction;
561
+
562
+ /**
563
+ * Unset lets the gateway choose, which prefers a device-to-device link where
564
+ * one can be brokered: it survives a gateway outage and runs at the devices'
565
+ * own rate. Name one to override that.
566
+ *
567
+ * @generated from field: kusinta.iot.link.v1.LinkMode mode = 4;
568
+ */
569
+ mode: LinkMode;
570
+
571
+ /**
572
+ * How a gateway-kept link is to behave, set as it is made. Carried here as
573
+ * well as on UpdateDeviceLink so that a link does not have to exist in a
574
+ * configured-by-nobody state first — a soft climate link created without a
575
+ * target is one that holds the room at nothing until a second request
576
+ * arrives, and every reader would have to handle that transient forever.
577
+ *
578
+ * Unset is still allowed and still means unconfigured, since a hard link has
579
+ * nothing to configure and a caller may genuinely not know the target yet.
580
+ *
581
+ * @generated from field: kusinta.iot.link.v1.LinkSettings settings = 5;
582
+ */
583
+ settings?: LinkSettings | undefined;
584
+ };
585
+
586
+ /**
587
+ * Describes the message kusinta.iot.webrtc.v1.CreateDeviceLink.
588
+ * Use `create(CreateDeviceLinkSchema)` to create a new message.
589
+ */
590
+ export declare const CreateDeviceLinkSchema: GenMessage<CreateDeviceLink>;
591
+
592
+ /**
593
+ * Removes a link. Note that on at least one vendor, removing a link disturbs the
594
+ * receiver's own settings and the connector must repair them, so this is not the
595
+ * no-op it appears to be.
596
+ *
597
+ * @generated from message kusinta.iot.webrtc.v1.RemoveDeviceLink
598
+ */
599
+ export declare type RemoveDeviceLink = Message<"kusinta.iot.webrtc.v1.RemoveDeviceLink"> & {
600
+ /**
601
+ * @generated from field: string link_id = 1;
602
+ */
603
+ linkId: string;
604
+ };
605
+
606
+ /**
607
+ * Describes the message kusinta.iot.webrtc.v1.RemoveDeviceLink.
608
+ * Use `create(RemoveDeviceLinkSchema)` to create a new message.
609
+ */
610
+ export declare const RemoveDeviceLinkSchema: GenMessage<RemoveDeviceLink>;
611
+
612
+ /**
613
+ * Changes how a gateway-kept link behaves — for a climate lead, the temperature
614
+ * it is to hold.
615
+ *
616
+ * Refused on a link that has nothing to configure — see LinkSettings — rather
617
+ * than accepted as a no-op, so that a caller who has mistaken which link they
618
+ * are holding is told.
619
+ *
620
+ * Authorized against both ends, as creating and removing the link are: deciding
621
+ * what temperature a room is held at is directing a device, not adjusting one,
622
+ * so it takes ownership of the ends or a servicing role, not the permission to
623
+ * turn a thermostat up. In a home it is its residents' instead (see CreateDeviceLink).
624
+ *
625
+ * @generated from message kusinta.iot.webrtc.v1.UpdateDeviceLink
626
+ */
627
+ export declare type UpdateDeviceLink = Message<"kusinta.iot.webrtc.v1.UpdateDeviceLink"> & {
628
+ /**
629
+ * @generated from field: string link_id = 1;
630
+ */
631
+ linkId: string;
632
+
633
+ /**
634
+ * Replaces the link's settings rather than patching them: the settings of one
635
+ * function are few and are set together, so there is no half-update worth
636
+ * expressing. This is why it does not follow UpdateSpace's per-field optional
637
+ * shape, which exists for a message whose fields genuinely move alone.
638
+ *
639
+ * Unset is refused rather than being given a meaning. It would have to mean
640
+ * either "leave everything alone", making the request a no-op, or "clear the
641
+ * settings", which is the one thing that reads like an accident — and the
642
+ * wire cannot tell those two callers apart.
643
+ *
644
+ * @generated from field: kusinta.iot.link.v1.LinkSettings settings = 2;
645
+ */
646
+ settings?: LinkSettings | undefined;
647
+ };
648
+
649
+ /**
650
+ * Describes the message kusinta.iot.webrtc.v1.UpdateDeviceLink.
651
+ * Use `create(UpdateDeviceLinkSchema)` to create a new message.
652
+ */
653
+ export declare const UpdateDeviceLinkSchema: GenMessage<UpdateDeviceLink>;
654
+
655
+ /**
656
+ * Lists links. Unset device_id lists every link among devices the caller can
657
+ * reach; naming one narrows it to that device's own, in either direction.
658
+ *
659
+ * A link with an end in a home reaches a caller who sees it as service with
660
+ * DeviceLink.details_withheld set, and what that withholds unset — a new link
661
+ * as it is made, a removed one at once — and not at all when either end is a
662
+ * device a resident owns.
663
+ *
664
+ * @generated from message kusinta.iot.webrtc.v1.ListDeviceLinks
665
+ */
666
+ export declare type ListDeviceLinks = Message<"kusinta.iot.webrtc.v1.ListDeviceLinks"> & {
667
+ /**
668
+ * @generated from field: kusinta.iot.identity.v1.DeviceId device_id = 1;
669
+ */
670
+ deviceId?: DeviceId | undefined;
671
+ };
672
+
673
+ /**
674
+ * Describes the message kusinta.iot.webrtc.v1.ListDeviceLinks.
675
+ * Use `create(ListDeviceLinksSchema)` to create a new message.
676
+ */
677
+ export declare const ListDeviceLinksSchema: GenMessage<ListDeviceLinks>;
678
+
679
+ /**
680
+ * Sets the temperature a room is to be held at.
681
+ *
682
+ * Authorized as adjusting, not directing: WRITE on the room is enough. It is the same act
683
+ * as turning a radiator's knob; setting up what the room obeys is ConfigureRoomClimate,
684
+ * and stays with owners, except the lock in a home.
685
+ *
686
+ * In a home, only its residents may set it; a caller who reaches the room as service is
687
+ * refused as NOT_ENTITLED.
688
+ *
689
+ * Clamped to the room's limits rather than refused outside them, and the clamped value is
690
+ * what the room's RoomClimate then reports.
691
+ *
692
+ * @generated from message kusinta.iot.webrtc.v1.SetRoomTarget
693
+ */
694
+ export declare type SetRoomTarget = Message<"kusinta.iot.webrtc.v1.SetRoomTarget"> & {
695
+ /**
696
+ * @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
697
+ */
698
+ roomId?: SpaceId | undefined;
699
+
700
+ /**
701
+ * Unset clears the target: the room goes back to having none (NO_TARGET) and its
702
+ * devices to their own behaviour. With presence, so that a request that forgot the
703
+ * field is not read as 0 °C and clamped to the room's minimum.
704
+ *
705
+ * @generated from field: optional sint32 target_centidegrees = 2;
706
+ */
707
+ targetCentidegrees?: number | undefined;
708
+ };
709
+
710
+ /**
711
+ * Describes the message kusinta.iot.webrtc.v1.SetRoomTarget.
712
+ * Use `create(SetRoomTargetSchema)` to create a new message.
713
+ */
714
+ export declare const SetRoomTargetSchema: GenMessage<SetRoomTarget>;
715
+
716
+ /**
717
+ * The sensors a room measures with, in order of preference. A message of its own so that
718
+ * "leave the sensors alone" (unset) differs from "set" on the wire. It orders the
719
+ * building's sensors only (see climate.v1.RoomClimate.sensor_ids); set but empty returns
720
+ * them to the default, every building temperature sensor filed in the room in filing
721
+ * order.
722
+ *
723
+ * @generated from message kusinta.iot.webrtc.v1.RoomSensors
724
+ */
725
+ export declare type RoomSensors = Message<"kusinta.iot.webrtc.v1.RoomSensors"> & {
726
+ /**
727
+ * @generated from field: repeated kusinta.iot.identity.v1.DeviceId sensor_ids = 1;
728
+ */
729
+ sensorIds: DeviceId[];
730
+ };
731
+
732
+ /**
733
+ * Describes the message kusinta.iot.webrtc.v1.RoomSensors.
734
+ * Use `create(RoomSensorsSchema)` to create a new message.
735
+ */
736
+ export declare const RoomSensorsSchema: GenMessage<RoomSensors>;
737
+
738
+ /**
739
+ * A room's limits. A message of its own so that "leave the limits alone" (unset) differs
740
+ * from "set" — and, set, an unset bound inside it removes that bound, which a bare
741
+ * optional on the request could not say.
742
+ *
743
+ * @generated from message kusinta.iot.webrtc.v1.RoomLimits
744
+ */
745
+ export declare type RoomLimits = Message<"kusinta.iot.webrtc.v1.RoomLimits"> & {
746
+ /**
747
+ * @generated from field: optional sint32 min_centidegrees = 1;
748
+ */
749
+ minCentidegrees?: number | undefined;
750
+
751
+ /**
752
+ * @generated from field: optional sint32 max_centidegrees = 2;
753
+ */
754
+ maxCentidegrees?: number | undefined;
755
+ };
756
+
757
+ /**
758
+ * Describes the message kusinta.iot.webrtc.v1.RoomLimits.
759
+ * Use `create(RoomLimitsSchema)` to create a new message.
760
+ */
761
+ export declare const RoomLimitsSchema: GenMessage<RoomLimits>;
762
+
763
+ /**
764
+ * Configures what a room obeys: its limits, its sensors, and whether a change made by
765
+ * hand at one of its devices counts. Authorized as directing — owners and filing roles —
766
+ * because this decides what everybody in the room can do.
767
+ *
768
+ * One exception: in a home, lock_device_controls is its residents' alone. They may send
769
+ * this request with nothing else set. Outside homes the lock is the owner's, as the rest
770
+ * is. A request that sets anything its caller may not — the lock in a home for service;
771
+ * anything but the lock in a home, or the lock outside one, for a caller with neither
772
+ * ROLE_PROPERTY_OWNER nor a filing role — is refused whole as NOT_ENTITLED, so nothing of
773
+ * it applies. sensors orders only the building's own
774
+ * sensors (see RoomClimate.sensor_ids).
775
+ *
776
+ * Each field moves alone, as on UpdateSpace: unset leaves it as it is.
777
+ *
778
+ * @generated from message kusinta.iot.webrtc.v1.ConfigureRoomClimate
779
+ */
780
+ export declare type ConfigureRoomClimate = Message<"kusinta.iot.webrtc.v1.ConfigureRoomClimate"> & {
781
+ /**
782
+ * @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
783
+ */
784
+ roomId?: SpaceId | undefined;
785
+
786
+ /**
787
+ * Replaces both bounds; see RoomLimits.
788
+ *
789
+ * @generated from field: kusinta.iot.webrtc.v1.RoomLimits limits = 2;
790
+ */
791
+ limits?: RoomLimits | undefined;
792
+
793
+ /**
794
+ * Only the building's sensors filed in this room; any other — including a sensor a
795
+ * resident owns — is refused, the same way whether or not it exists.
796
+ *
797
+ * @generated from field: kusinta.iot.webrtc.v1.RoomSensors sensors = 3;
798
+ */
799
+ sensors?: RoomSensors | undefined;
800
+
801
+ /**
802
+ * @generated from field: optional bool lock_device_controls = 4;
803
+ */
804
+ lockDeviceControls?: boolean | undefined;
805
+ };
806
+
807
+ /**
808
+ * Describes the message kusinta.iot.webrtc.v1.ConfigureRoomClimate.
809
+ * Use `create(ConfigureRoomClimateSchema)` to create a new message.
810
+ */
811
+ export declare const ConfigureRoomClimateSchema: GenMessage<ConfigureRoomClimate>;
812
+
813
+ /**
814
+ * Switches a mode on a space on, or off with kind UNSPECIFIED. WRITE on the space.
815
+ * Switching one on needs setback_centidegrees; a mode with nothing to set back to is
816
+ * refused. Switching one on is refused on a room inside an apartment, whose rooms follow
817
+ * the apartment's mode alone; such a room carries none (see climate.v1.ClimateMode), and
818
+ * switching one off there is accepted and does nothing — for those who may switch modes in
819
+ * that home at all, which is checked first: anyone else is refused as NOT_ENTITLED.
820
+ *
821
+ * In a home, only its residents may switch one on or off: whether a home stands empty is
822
+ * theirs to say. A caller who reaches it as service is refused as NOT_ENTITLED — except
823
+ * that, while the home has no resident, ROLE_PROPERTY_OWNER or ROLE_GATEWAY_ADMIN may
824
+ * switch off a mode that is on and whose setter is not a resident, so that no mode
825
+ * outlives everyone who could end it. Any other switch-off from them — no mode on, or one
826
+ * that is a resident's — is accepted and does nothing, so the answer tells them nothing of
827
+ * whether a mode was on or whether anyone has moved in.
828
+ *
829
+ * @generated from message kusinta.iot.webrtc.v1.SetClimateMode
830
+ */
831
+ export declare type SetClimateMode = Message<"kusinta.iot.webrtc.v1.SetClimateMode"> & {
832
+ /**
833
+ * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
834
+ */
835
+ spaceId?: SpaceId | undefined;
836
+
837
+ /**
838
+ * @generated from field: kusinta.iot.climate.v1.ClimateModeKind kind = 2;
839
+ */
840
+ kind: ClimateModeKind;
841
+
842
+ /**
843
+ * @generated from field: optional sint32 setback_centidegrees = 3;
844
+ */
845
+ setbackCentidegrees?: number | undefined;
846
+
847
+ /**
848
+ * HOLIDAY only; both required there. Refused on AWAY.
849
+ *
850
+ * @generated from field: google.protobuf.Timestamp starts_at = 4;
851
+ */
852
+ startsAt?: Timestamp | undefined;
853
+
854
+ /**
855
+ * @generated from field: google.protobuf.Timestamp ends_at = 5;
856
+ */
857
+ endsAt?: Timestamp | undefined;
858
+ };
859
+
860
+ /**
861
+ * Describes the message kusinta.iot.webrtc.v1.SetClimateMode.
862
+ * Use `create(SetClimateModeSchema)` to create a new message.
863
+ */
864
+ export declare const SetClimateModeSchema: GenMessage<SetClimateMode>;
865
+
866
+ /**
867
+ * Lists the room climates and modes a caller may see. Unset root_space_id lists every
868
+ * one the caller can reach; naming a space narrows it to that space and those below.
376
869
  *
870
+ * A caller who reaches a room inside an apartment as service gets it with
871
+ * RoomClimate.state_withheld set — what is new as it happens, what is gone at once — and
872
+ * gets no ClimateMode set on that apartment or its rooms.
873
+ *
874
+ * @generated from message kusinta.iot.webrtc.v1.ListRoomClimates
875
+ */
876
+ export declare type ListRoomClimates = Message<"kusinta.iot.webrtc.v1.ListRoomClimates"> & {
877
+ /**
878
+ * @generated from field: kusinta.iot.identity.v1.SpaceId root_space_id = 1;
879
+ */
880
+ rootSpaceId?: SpaceId | undefined;
881
+ };
882
+
883
+ /**
884
+ * Describes the message kusinta.iot.webrtc.v1.ListRoomClimates.
885
+ * Use `create(ListRoomClimatesSchema)` to create a new message.
886
+ */
887
+ export declare const ListRoomClimatesSchema: GenMessage<ListRoomClimates>;
888
+
889
+ /**
890
+ * Reads a room's history, answered with a climate.v1.RoomHistory of fixed 15-minute
891
+ * buckets aligned to UTC quarter hours (:00, :15, :30, :45). Needs READ on the room.
892
+ *
893
+ * The range is half-open: a bucket is returned when from_time <= at < to_time, so
894
+ * back-to-back windows neither repeat nor skip a bucket. Unset to_time means now;
895
+ * unset from_time means RoomHistory.kept_from. Both are clamped to [kept_from, now].
896
+ *
897
+ * A room in a home is readable by its residents only, and only from the start of their
898
+ * current residency (see access.v1.MembershipRelation). A caller who reaches it as service is
899
+ * refused as NOT_ENTITLED; one who reaches the apartment itself has
900
+ * GetApartmentClimateSummary instead.
901
+ *
902
+ * @generated from message kusinta.iot.webrtc.v1.GetRoomHistory
903
+ */
904
+ export declare type GetRoomHistory = Message<"kusinta.iot.webrtc.v1.GetRoomHistory"> & {
905
+ /**
906
+ * @generated from field: kusinta.iot.identity.v1.SpaceId room_id = 1;
907
+ */
908
+ roomId?: SpaceId | undefined;
909
+
910
+ /**
911
+ * @generated from field: google.protobuf.Timestamp from_time = 2;
912
+ */
913
+ fromTime?: Timestamp | undefined;
914
+
915
+ /**
916
+ * @generated from field: google.protobuf.Timestamp to_time = 3;
917
+ */
918
+ toTime?: Timestamp | undefined;
919
+ };
920
+
921
+ /**
922
+ * Describes the message kusinta.iot.webrtc.v1.GetRoomHistory.
923
+ * Use `create(GetRoomHistorySchema)` to create a new message.
924
+ */
925
+ export declare const GetRoomHistorySchema: GenMessage<GetRoomHistory>;
926
+
927
+ /**
928
+ * What the parties who do not live in a private space learn of it — the answer to a
929
+ * resident asking who can see what in their home, in reply to GetPrivacyDisclosure.
930
+ *
931
+ * It states the policy, the kinds of party it applies to now and the people counted under
932
+ * each (ServiceParty.names): a resident learns which technicians can see the battery of
933
+ * their radiator valve. The names say who has reach, never where anyone lives.
934
+ *
935
+ * @generated from message kusinta.iot.webrtc.v1.PrivacyDisclosure
936
+ */
937
+ export declare type PrivacyDisclosure = Message<"kusinta.iot.webrtc.v1.PrivacyDisclosure"> & {
938
+ /**
939
+ * An apartment, or a room in one.
940
+ *
941
+ * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
942
+ */
943
+ spaceId?: SpaceId | undefined;
944
+
945
+ /**
946
+ * The kinds of party who see this space, or any part of it, as service now — or would
947
+ * through another membership, were they not its residents — each role once, with what
948
+ * that role brings here. Each party is listed under every role it holds other than
949
+ * ROLE_RESIDENT, and sees what its entries say together; one with no other role, or whose
950
+ * role the gateway has not yet learnt, counts as ROLE_UNSPECIFIED. ROLE_GATEWAY_ADMIN is
951
+ * always listed, and ROLE_PROPERTY_OWNER whenever anyone holds it, wherever they are
952
+ * filed: both may file themselves on the home. So the list reads the same whether or not
953
+ * anyone lives in the home, and never understates who has reach or what they see. Devices a resident
954
+ * owns are not shown to service at all.
955
+ *
956
+ * @generated from field: repeated kusinta.iot.webrtc.v1.ServiceParty service_parties = 5;
957
+ */
958
+ serviceParties: ServiceParty[];
959
+
960
+ /**
961
+ * How finely the space's climate is summarised for service, as means over periods of
962
+ * this length (climate.v1.ApartmentClimateSummary). UNSPECIFIED: no summary is given.
963
+ * The gateway's own setting, WEEK unless it is configured otherwise; no operation in this
964
+ * contract changes it. A change applies to periods that open after it: service is given
965
+ * no period that opened before the last change.
966
+ *
967
+ * @generated from field: kusinta.iot.climate.v1.ClimateSummaryPeriod climate_summary_period = 4;
968
+ */
969
+ climateSummaryPeriod: ClimateSummaryPeriod;
970
+
971
+ /**
972
+ * The name of the organisation that owns the property, when one is recorded
973
+ * (SetOwnerOrganisation). Its organisation number is not given here.
974
+ *
975
+ * @generated from field: string owner_organisation_name = 6;
976
+ */
977
+ ownerOrganisationName: string;
978
+
979
+ /**
980
+ * Set when ServiceParty.names are not given to this caller, so that empty lists are not
981
+ * read as nobody being named. Names are given to the home's own residents and to a
982
+ * caller holding ROLE_GATEWAY_ADMIN or ROLE_PROPERTY_OWNER, and withheld from anyone
983
+ * else: a technician who reaches the home learns the kinds of party, not who they are.
984
+ *
985
+ * @generated from field: bool names_withheld = 7;
986
+ */
987
+ namesWithheld: boolean;
988
+ };
989
+
990
+ /**
991
+ * Describes the message kusinta.iot.webrtc.v1.PrivacyDisclosure.
992
+ * Use `create(PrivacyDisclosureSchema)` to create a new message.
993
+ */
994
+ export declare const PrivacyDisclosureSchema: GenMessage<PrivacyDisclosure>;
995
+
996
+ /**
997
+ * One kind of party with service reach of a home, and what it sees there. Every service
998
+ * party sees the same kinds of thing of the part of the home it reaches — a whole
999
+ * ServiceStatus, nothing withheld from it — so signals differ between parties only in
1000
+ * RESIDENTS. How much of the home that part is, a room or all of it, the disclosure does
1001
+ * not say.
1002
+ *
1003
+ * @generated from message kusinta.iot.webrtc.v1.ServiceParty
1004
+ */
1005
+ export declare type ServiceParty = Message<"kusinta.iot.webrtc.v1.ServiceParty"> & {
1006
+ /**
1007
+ * @generated from field: kusinta.iot.access.v1.Role role = 1;
1008
+ */
1009
+ role: Role;
1010
+
1011
+ /**
1012
+ * @generated from field: repeated kusinta.iot.access.v1.ServiceSignal signals = 2;
1013
+ */
1014
+ signals: ServiceSignal[];
1015
+
1016
+ /**
1017
+ * Each person counted under this role, by the name they gave their account
1018
+ * (AppTokenClaims.name), once each: everyone holding ROLE_GATEWAY_ADMIN or
1019
+ * ROLE_PROPERTY_OWNER, the registering administrator included once the gateway has seen
1020
+ * their token, and everyone else counted here by a SERVICE membership. A person counted
1021
+ * under several roles is named under each. An empty string stands for a person whose name
1022
+ * the gateway has not learnt, so the list is as long as the number of people. Self-chosen,
1023
+ * so the app shows it as the name they gave rather than as a verified identity. Empty for
1024
+ * every party when PrivacyDisclosure.names_withheld is set.
1025
+ *
1026
+ * @generated from field: repeated string names = 3;
1027
+ */
1028
+ names: string[];
1029
+ };
1030
+
1031
+ /**
1032
+ * Describes the message kusinta.iot.webrtc.v1.ServiceParty.
1033
+ * Use `create(ServicePartySchema)` to create a new message.
1034
+ */
1035
+ export declare const ServicePartySchema: GenMessage<ServiceParty>;
1036
+
1037
+ /**
1038
+ * Asks what the parties who do not live in a space learn of it, answered with a
1039
+ * PrivacyDisclosure. For an apartment or a room in one, and refused on any other
1040
+ * space. Needs READ on the space.
1041
+ *
1042
+ * @generated from message kusinta.iot.webrtc.v1.GetPrivacyDisclosure
1043
+ */
1044
+ export declare type GetPrivacyDisclosure = Message<"kusinta.iot.webrtc.v1.GetPrivacyDisclosure"> & {
1045
+ /**
1046
+ * @generated from field: kusinta.iot.identity.v1.SpaceId space_id = 1;
1047
+ */
1048
+ spaceId?: SpaceId | undefined;
1049
+ };
1050
+
1051
+ /**
1052
+ * Describes the message kusinta.iot.webrtc.v1.GetPrivacyDisclosure.
1053
+ * Use `create(GetPrivacyDisclosureSchema)` to create a new message.
1054
+ */
1055
+ export declare const GetPrivacyDisclosureSchema: GenMessage<GetPrivacyDisclosure>;
1056
+
1057
+ /**
1058
+ * Reads an apartment's climate as means over whole periods, answered with a
1059
+ * climate.v1.ApartmentClimateSummary. Needs READ on the apartment itself. Refused on a
1060
+ * space that is not an apartment, and while the building's time zone (Space.time_zone) is
1061
+ * unknown, since periods are cut at its midnights.
1062
+ *
1063
+ * The range is half-open over the periods' starts: a period is returned when from_time <=
1064
+ * starts_at < to_time. Unset from_time means kept_from; unset to_time means now. Both are
1065
+ * clamped to [kept_from, the start of the period running now — or now, if none is] (see
1066
+ * ApartmentClimateSummary).
1067
+ *
1068
+ * @generated from message kusinta.iot.webrtc.v1.GetApartmentClimateSummary
1069
+ */
1070
+ export declare type GetApartmentClimateSummary = Message<"kusinta.iot.webrtc.v1.GetApartmentClimateSummary"> & {
1071
+ /**
1072
+ * @generated from field: kusinta.iot.identity.v1.SpaceId apartment_id = 1;
1073
+ */
1074
+ apartmentId?: SpaceId | undefined;
1075
+
1076
+ /**
1077
+ * Unset asks for the period the apartment's privacy disclosure names
1078
+ * (PrivacyDisclosure.climate_summary_period), or weeks when it names none. Anyone but the
1079
+ * apartment's residents may ask for that period only, and is refused as NOT_ENTITLED for
1080
+ * any other or when it names none. Its residents may ask for any, and are given only
1081
+ * periods that began in their current residency.
1082
+ *
1083
+ * @generated from field: kusinta.iot.climate.v1.ClimateSummaryPeriod period = 2;
1084
+ */
1085
+ period: ClimateSummaryPeriod;
1086
+
1087
+ /**
1088
+ * @generated from field: google.protobuf.Timestamp from_time = 3;
1089
+ */
1090
+ fromTime?: Timestamp | undefined;
1091
+
1092
+ /**
1093
+ * @generated from field: google.protobuf.Timestamp to_time = 4;
1094
+ */
1095
+ toTime?: Timestamp | undefined;
1096
+ };
1097
+
1098
+ /**
1099
+ * Describes the message kusinta.iot.webrtc.v1.GetApartmentClimateSummary.
1100
+ * Use `create(GetApartmentClimateSummarySchema)` to create a new message.
1101
+ */
1102
+ export declare const GetApartmentClimateSummarySchema: GenMessage<GetApartmentClimateSummary>;
1103
+
1104
+ /**
1105
+ * Asks the gateway to have a connector re-initialise its backend connection: reconnect to
1106
+ * its radio central or network server. Meant to be offered while a
1107
+ * reporting.v1.PROBLEM_KIND_CONNECTOR_ERROR is open for the connector — its
1108
+ * ConnectorDescriptor.backend_health is FAILING — and only for a connector listed in
1109
+ * ConnectorsAnnounced. A request for a connector that is not listed is refused, as
1110
+ * CONNECTOR_OFFLINE or UNKNOWN_CONNECTOR below. For a listed one it is accepted whatever its
1111
+ * health, since re-initialising a healthy backend is harmless.
1112
+ *
1113
+ * Authorized against the caller's role alone, as StartPairing is: a connector is not a
1114
+ * target the caller reaches the way a space is. ROLE_TECHNICIAN and ROLE_GATEWAY_ADMIN may
1115
+ * ask; anyone else is refused as NOT_ENTITLED, before the connector is looked up, so the
1116
+ * refusal says nothing of which connectors exist.
1117
+ *
1118
+ * The gateway forwards it as connector.v1.ReinitializeBackend and answers once the
1119
+ * connector has: with ManagementAck when the attempt was made. That says the attempt
1120
+ * finished, not that it worked. Whether it worked is the connector's backend health, and
1121
+ * when that changed the gateway pushes it in ConnectorsAnnounced before the ack. One
1122
+ * request at a time per connector.
1123
+ *
1124
+ * So a failure found only by attempting — credentials the backend rejects, a backend that
1125
+ * does not answer — is not a refusal. It arrives as a ManagementAck, with the backend
1126
+ * health it left (FAILING, e.g. with AUTH_FAILED, UNREACHABLE or BACKEND_ERROR) already
1127
+ * pushed: after the ack, the app reads ConnectorDescriptor.backend_health for the outcome,
1128
+ * and a FAILING health there means the reconnect did not help. The app handles any reason
1129
+ * there, one its schema does not know included. No push precedes the ack when the attempt
1130
+ * left health as it was; the descriptor the app holds is then still the outcome.
1131
+ *
1132
+ * A refusal is a GatewayError whose metadata "reason" says which, as CommandError.metadata
1133
+ * describes, and whose "detail" is a sentence the app may show. The app branches on
1134
+ * "reason" for this operation; the code is only the fallback for a reason it does not know,
1135
+ * since GatewayErrorCode is too coarse to say what to do here. The role refusal above is
1136
+ * the code NOT_ENTITLED alone, with no "reason"; the reasons are for a caller who may ask:
1137
+ * "UNKNOWN_CONNECTOR" UNAVAILABLE. The gateway does not track a connector by that id:
1138
+ * it never had one, or has stopped tracking it. Not a client bug:
1139
+ * the list the app holds may be stale.
1140
+ * "CONNECTOR_OFFLINE" UNAVAILABLE. A connector the gateway tracks, whose stream to the
1141
+ * gateway is down now, before or while the request was
1142
+ * outstanding; that is CONNECTOR_OFFLINE, and a reconnect of its
1143
+ * backend cannot help it.
1144
+ * "NOT_SUPPORTED" FAILED_PRECONDITION. The connector does not declare
1145
+ * ConnectorDescriptor.supports_backend_reinitialize, or declared it
1146
+ * and answered that it has nothing to re-initialise. Not a client
1147
+ * bug, and not worth retrying as is.
1148
+ * "ALREADY_IN_PROGRESS" UNAVAILABLE. A reconnect of this connector is outstanding, from
1149
+ * this caller or another. It ends within 60 seconds of being
1150
+ * asked, answered or timed out; retry after that. Only the caller
1151
+ * who asked is answered, but a change of health it causes reaches
1152
+ * every session in ConnectorsAnnounced.
1153
+ * "TIMED_OUT" UNAVAILABLE. The connector did not answer within the gateway's
1154
+ * deadline. The attempt may still finish, and its outcome still
1155
+ * arrives as backend health.
1156
+ * "REINITIALIZE_FAILED" The connector could not attempt it at all
1157
+ * (connector.v1.REINITIALIZE_OUTCOME_FAILED, or an outcome the
1158
+ * gateway's schema does not know, read as FAILED). The code
1159
+ * depends on the reason: FAILED_PRECONDITION when it is
1160
+ * MISCONFIGURED, which needs a person to correct the connector's
1161
+ * configuration before asking again can help; UNAVAILABLE for
1162
+ * any other — INTERNAL, UNSPECIFIED, a value the gateway does not
1163
+ * know — since a retry may work. Rejected credentials are never
1164
+ * this: they are found by attempting, and come back as an ack
1165
+ * (see above). metadata "backend_failure" is always set: the
1166
+ * common.v1.BackendFailureReason by its enum name, e.g.
1167
+ * "BACKEND_FAILURE_REASON_MISCONFIGURED". A reason that is
1168
+ * UNSPECIFIED, or a value the gateway's schema does not know, is
1169
+ * sent as "BACKEND_FAILURE_REASON_BACKEND_ERROR", as
1170
+ * BackendFailureReason has it; an app reading a name its own
1171
+ * schema does not know treats it as BACKEND_ERROR too.
1172
+ * The connector's own detail is never in a refusal; GatewayError.message is the gateway's.
1173
+ *
1174
+ * @generated from message kusinta.iot.webrtc.v1.ReconnectConnector
1175
+ */
1176
+ export declare type ReconnectConnector = Message<"kusinta.iot.webrtc.v1.ReconnectConnector"> & {
1177
+ /**
1178
+ * As ConnectorDescriptor.connector_id, and the id a CONNECTOR_ERROR problem's subject
1179
+ * names (reporting.v1.ProblemSubject.connector_id).
1180
+ *
1181
+ * @generated from field: kusinta.iot.identity.v1.ConnectorId connector_id = 1;
1182
+ */
1183
+ connectorId?: ConnectorId | undefined;
1184
+ };
1185
+
1186
+ /**
1187
+ * Describes the message kusinta.iot.webrtc.v1.ReconnectConnector.
1188
+ * Use `create(ReconnectConnectorSchema)` to create a new message.
1189
+ */
1190
+ export declare const ReconnectConnectorSchema: GenMessage<ReconnectConnector>;
1191
+
1192
+ /**
377
1193
  * @generated from message kusinta.iot.webrtc.v1.ManagementRequest
378
1194
  */
379
1195
  export declare type ManagementRequest = Message<"kusinta.iot.webrtc.v1.ManagementRequest"> & {
@@ -440,6 +1256,160 @@ export declare type ManagementRequest = Message<"kusinta.iot.webrtc.v1.Managemen
440
1256
  */
441
1257
  value: ListSpaces;
442
1258
  case: "listSpaces";
1259
+ } | {
1260
+ /**
1261
+ * @generated from field: kusinta.iot.webrtc.v1.CreateDeviceLink create_device_link = 11;
1262
+ */
1263
+ value: CreateDeviceLink;
1264
+ case: "createDeviceLink";
1265
+ } | {
1266
+ /**
1267
+ * @generated from field: kusinta.iot.webrtc.v1.RemoveDeviceLink remove_device_link = 12;
1268
+ */
1269
+ value: RemoveDeviceLink;
1270
+ case: "removeDeviceLink";
1271
+ } | {
1272
+ /**
1273
+ * @generated from field: kusinta.iot.webrtc.v1.ListDeviceLinks list_device_links = 13;
1274
+ */
1275
+ value: ListDeviceLinks;
1276
+ case: "listDeviceLinks";
1277
+ } | {
1278
+ /**
1279
+ * @generated from field: kusinta.iot.webrtc.v1.UpdateDeviceLink update_device_link = 14;
1280
+ */
1281
+ value: UpdateDeviceLink;
1282
+ case: "updateDeviceLink";
1283
+ } | {
1284
+ /**
1285
+ * @generated from field: kusinta.iot.webrtc.v1.ProvisionDevice provision_device = 15;
1286
+ */
1287
+ value: ProvisionDevice;
1288
+ case: "provisionDevice";
1289
+ } | {
1290
+ /**
1291
+ * @generated from field: kusinta.iot.webrtc.v1.SetRoomTarget set_room_target = 16;
1292
+ */
1293
+ value: SetRoomTarget;
1294
+ case: "setRoomTarget";
1295
+ } | {
1296
+ /**
1297
+ * @generated from field: kusinta.iot.webrtc.v1.ConfigureRoomClimate configure_room_climate = 17;
1298
+ */
1299
+ value: ConfigureRoomClimate;
1300
+ case: "configureRoomClimate";
1301
+ } | {
1302
+ /**
1303
+ * @generated from field: kusinta.iot.webrtc.v1.SetClimateMode set_climate_mode = 18;
1304
+ */
1305
+ value: SetClimateMode;
1306
+ case: "setClimateMode";
1307
+ } | {
1308
+ /**
1309
+ * @generated from field: kusinta.iot.webrtc.v1.ListRoomClimates list_room_climates = 19;
1310
+ */
1311
+ value: ListRoomClimates;
1312
+ case: "listRoomClimates";
1313
+ } | {
1314
+ /**
1315
+ * @generated from field: kusinta.iot.webrtc.v1.GetRoomHistory get_room_history = 20;
1316
+ */
1317
+ value: GetRoomHistory;
1318
+ case: "getRoomHistory";
1319
+ } | {
1320
+ /**
1321
+ * @generated from field: kusinta.iot.webrtc.v1.GetPrivacyDisclosure get_privacy_disclosure = 21;
1322
+ */
1323
+ value: GetPrivacyDisclosure;
1324
+ case: "getPrivacyDisclosure";
1325
+ } | {
1326
+ /**
1327
+ * @generated from field: kusinta.iot.webrtc.v1.GetApartmentClimateSummary get_apartment_climate_summary = 22;
1328
+ */
1329
+ value: GetApartmentClimateSummary;
1330
+ case: "getApartmentClimateSummary";
1331
+ } | {
1332
+ /**
1333
+ * @generated from field: kusinta.iot.webrtc.v1.ReconnectConnector reconnect_connector = 23;
1334
+ */
1335
+ value: ReconnectConnector;
1336
+ case: "reconnectConnector";
1337
+ } | {
1338
+ /**
1339
+ * Invites; see invite.proto.
1340
+ *
1341
+ * @generated from field: kusinta.iot.webrtc.v1.CreateInvite create_invite = 24;
1342
+ */
1343
+ value: CreateInvite;
1344
+ case: "createInvite";
1345
+ } | {
1346
+ /**
1347
+ * @generated from field: kusinta.iot.webrtc.v1.ResendInvite resend_invite = 25;
1348
+ */
1349
+ value: ResendInvite;
1350
+ case: "resendInvite";
1351
+ } | {
1352
+ /**
1353
+ * @generated from field: kusinta.iot.webrtc.v1.RevokeInvite revoke_invite = 26;
1354
+ */
1355
+ value: RevokeInvite;
1356
+ case: "revokeInvite";
1357
+ } | {
1358
+ /**
1359
+ * @generated from field: kusinta.iot.webrtc.v1.MarkInviteEmailSent mark_invite_email_sent = 27;
1360
+ */
1361
+ value: MarkInviteEmailSent;
1362
+ case: "markInviteEmailSent";
1363
+ } | {
1364
+ /**
1365
+ * @generated from field: kusinta.iot.webrtc.v1.ListSpaceInvites list_space_invites = 28;
1366
+ */
1367
+ value: ListSpaceInvites;
1368
+ case: "listSpaceInvites";
1369
+ } | {
1370
+ /**
1371
+ * @generated from field: kusinta.iot.webrtc.v1.ApproveJoinRequest approve_join_request = 29;
1372
+ */
1373
+ value: ApproveJoinRequest;
1374
+ case: "approveJoinRequest";
1375
+ } | {
1376
+ /**
1377
+ * @generated from field: kusinta.iot.webrtc.v1.DenyJoinRequest deny_join_request = 30;
1378
+ */
1379
+ value: DenyJoinRequest;
1380
+ case: "denyJoinRequest";
1381
+ } | {
1382
+ /**
1383
+ * Members; see members.proto.
1384
+ *
1385
+ * @generated from field: kusinta.iot.webrtc.v1.ListGatewayMembers list_gateway_members = 31;
1386
+ */
1387
+ value: ListGatewayMembers;
1388
+ case: "listGatewayMembers";
1389
+ } | {
1390
+ /**
1391
+ * @generated from field: kusinta.iot.webrtc.v1.SetMemberRole set_member_role = 32;
1392
+ */
1393
+ value: SetMemberRole;
1394
+ case: "setMemberRole";
1395
+ } | {
1396
+ /**
1397
+ * @generated from field: kusinta.iot.webrtc.v1.RemoveFromGateway remove_from_gateway = 33;
1398
+ */
1399
+ value: RemoveFromGateway;
1400
+ case: "removeFromGateway";
1401
+ } | {
1402
+ /**
1403
+ * @generated from field: kusinta.iot.webrtc.v1.SetAccessUntil set_access_until = 34;
1404
+ */
1405
+ value: SetAccessUntil;
1406
+ case: "setAccessUntil";
1407
+ } | {
1408
+ /**
1409
+ * @generated from field: kusinta.iot.webrtc.v1.SetOwnerOrganisation set_owner_organisation = 35;
1410
+ */
1411
+ value: SetOwnerOrganisation;
1412
+ case: "setOwnerOrganisation";
443
1413
  } | { case: undefined; value?: undefined };
444
1414
  };
445
1415