@seamapi/types 1.1042.0 → 1.1044.0

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.
@@ -11896,7 +11896,7 @@ export type Routes = {
11896
11896
  starts_at: string;
11897
11897
  /** Date and time at which the Access Grant ends. */
11898
11898
  ends_at: string | null;
11899
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
11899
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
11900
11900
  display_status: string;
11901
11901
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
11902
11902
  warnings: ({
@@ -12108,7 +12108,7 @@ export type Routes = {
12108
12108
  starts_at: string;
12109
12109
  /** Date and time at which the Access Grant ends. */
12110
12110
  ends_at: string | null;
12111
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
12111
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
12112
12112
  display_status: string;
12113
12113
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
12114
12114
  warnings: ({
@@ -14773,7 +14773,7 @@ export type Routes = {
14773
14773
  starts_at: string;
14774
14774
  /** Date and time at which the Access Grant ends. */
14775
14775
  ends_at: string | null;
14776
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
14776
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
14777
14777
  display_status: string;
14778
14778
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
14779
14779
  warnings: ({
@@ -14987,7 +14987,7 @@ export type Routes = {
14987
14987
  starts_at: string;
14988
14988
  /** Date and time at which the Access Grant ends. */
14989
14989
  ends_at: string | null;
14990
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
14990
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
14991
14991
  display_status: string;
14992
14992
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
14993
14993
  warnings: ({
@@ -21118,7 +21118,7 @@ export type Routes = {
21118
21118
  starts_at: string;
21119
21119
  /** Date and time at which the Access Grant ends. */
21120
21120
  ends_at: string | null;
21121
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
21121
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
21122
21122
  display_status: string;
21123
21123
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
21124
21124
  warnings: ({
@@ -50085,10 +50085,13 @@ export type Routes = {
50085
50085
  [x: string]: string | boolean;
50086
50086
  } | undefined;
50087
50087
  event_type: 'device.low_battery';
50088
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
50088
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
50089
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
50089
50090
  battery_level: number;
50090
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
50091
- battery_source?: ('lock' | 'accessory_keypad') | undefined;
50091
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
50092
+ device_battery_level?: number | undefined;
50093
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
50094
+ accessory_keypad_battery_level?: number | undefined;
50092
50095
  } | {
50093
50096
  /** ID of the event. */
50094
50097
  event_id: string;
@@ -53713,10 +53716,13 @@ export type Routes = {
53713
53716
  [x: string]: string | boolean;
53714
53717
  } | undefined;
53715
53718
  event_type: 'device.low_battery';
53716
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
53719
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
53720
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
53717
53721
  battery_level: number;
53718
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
53719
- battery_source?: ('lock' | 'accessory_keypad') | undefined;
53722
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
53723
+ device_battery_level?: number | undefined;
53724
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
53725
+ accessory_keypad_battery_level?: number | undefined;
53720
53726
  } | {
53721
53727
  /** ID of the event. */
53722
53728
  event_id: string;
@@ -80095,7 +80101,7 @@ export type Routes = {
80095
80101
  starts_at: string;
80096
80102
  /** Date and time at which the Access Grant ends. */
80097
80103
  ends_at: string | null;
80098
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
80104
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
80099
80105
  display_status: string;
80100
80106
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
80101
80107
  warnings: ({
@@ -85409,10 +85415,13 @@ export type Routes = {
85409
85415
  [x: string]: string | boolean;
85410
85416
  } | undefined;
85411
85417
  event_type: 'device.low_battery';
85412
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
85418
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
85419
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
85413
85420
  battery_level: number;
85414
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
85415
- battery_source?: ('lock' | 'accessory_keypad') | undefined;
85421
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
85422
+ device_battery_level?: number | undefined;
85423
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
85424
+ accessory_keypad_battery_level?: number | undefined;
85416
85425
  } | {
85417
85426
  /** ID of the event. */
85418
85427
  event_id: string;
@@ -86980,7 +86989,7 @@ export type Routes = {
86980
86989
  starts_at: string;
86981
86990
  /** Date and time at which the Access Grant ends. */
86982
86991
  ends_at: string | null;
86983
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
86992
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
86984
86993
  display_status: string;
86985
86994
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
86986
86995
  warnings: ({
@@ -87483,7 +87492,7 @@ export type Routes = {
87483
87492
  starts_at: string;
87484
87493
  /** Date and time at which the Access Grant ends. */
87485
87494
  ends_at: string | null;
87486
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
87495
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
87487
87496
  display_status: string;
87488
87497
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
87489
87498
  warnings: ({
@@ -122623,7 +122632,7 @@ export type Routes = {
122623
122632
  starts_at: string;
122624
122633
  /** Date and time at which the Access Grant ends. */
122625
122634
  ends_at: string | null;
122626
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
122635
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
122627
122636
  display_status: string;
122628
122637
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
122629
122638
  warnings: ({
@@ -125447,10 +125456,13 @@ export type Routes = {
125447
125456
  [x: string]: string | boolean;
125448
125457
  } | undefined;
125449
125458
  event_type: 'device.low_battery';
125450
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
125459
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
125460
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
125451
125461
  battery_level: number;
125452
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
125453
- battery_source?: ('lock' | 'accessory_keypad') | undefined;
125462
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
125463
+ device_battery_level?: number | undefined;
125464
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
125465
+ accessory_keypad_battery_level?: number | undefined;
125454
125466
  } | {
125455
125467
  /** ID of the event. */
125456
125468
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1042.0",
3
+ "version": "1.1044.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -283,7 +283,7 @@ export const access_grant = z.object({
283
283
  display_status: z
284
284
  .string()
285
285
  .describe(
286
- "Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields.",
286
+ "Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields.",
287
287
  ),
288
288
  warnings: z
289
289
  .array(access_grant_warning)
@@ -326,7 +326,7 @@ export const unmanaged_access_grant = access_grant
326
326
  access_grant_key: true,
327
327
  user_identity_id: true,
328
328
  // Seam does not provision these grants, so it has no basis for saying
329
- // whether access works — "blocked" would be a claim about another system.
329
+ // whether access works — any verdict would be a claim about another system.
330
330
  display_status: true,
331
331
  })
332
332
  .extend({
@@ -45,10 +45,20 @@ const device_battery_status = z
45
45
  'Battery status of the affected device, calculated from the numeric `battery_level` value.',
46
46
  )
47
47
 
48
- const battery_source = z
49
- .enum(['lock', 'accessory_keypad'])
48
+ const device_battery_level = z
49
+ .number()
50
+ .min(0)
51
+ .max(1)
52
+ .describe(
53
+ "Number in the range 0 to 1.0 indicating the affected device's own battery level, when known.",
54
+ )
55
+
56
+ const accessory_keypad_battery_level = z
57
+ .number()
58
+ .min(0)
59
+ .max(1)
50
60
  .describe(
51
- "Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery.",
61
+ "Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known.",
52
62
  )
53
63
 
54
64
  const disconnection_error_code = z
@@ -181,8 +191,14 @@ export type DeviceTamperedEvent = z.infer<typeof device_tampered_event>
181
191
 
182
192
  export const device_low_battery_event = device_event.extend({
183
193
  event_type: z.literal('device.low_battery'),
184
- battery_level,
185
- battery_source: battery_source.optional(),
194
+ battery_level: battery_level.describe(`
195
+ ---
196
+ deprecated: Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.
197
+ ---
198
+ Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
199
+ `),
200
+ device_battery_level: device_battery_level.optional(),
201
+ accessory_keypad_battery_level: accessory_keypad_battery_level.optional(),
186
202
  }).describe(`
187
203
  ---
188
204
  route_path: /devices
@@ -1821,7 +1821,7 @@ const openapi: OpenAPISpec = {
1821
1821
  },
1822
1822
  display_status: {
1823
1823
  description:
1824
- "Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields.",
1824
+ "Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields.",
1825
1825
  type: 'string',
1826
1826
  },
1827
1827
  ends_at: {
@@ -25989,19 +25989,24 @@ const openapi: OpenAPISpec = {
25989
25989
  description:
25990
25990
  'A device battery level dropped below the low threshold.',
25991
25991
  properties: {
25992
- battery_level: {
25992
+ accessory_keypad_battery_level: {
25993
25993
  description:
25994
- 'Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.',
25994
+ "Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known.",
25995
25995
  format: 'float',
25996
25996
  maximum: 1,
25997
25997
  minimum: 0,
25998
25998
  type: 'number',
25999
25999
  },
26000
- battery_source: {
26000
+ battery_level: {
26001
+ deprecated: true,
26001
26002
  description:
26002
- "Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery.",
26003
- enum: ['lock', 'accessory_keypad'],
26004
- type: 'string',
26003
+ 'Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.',
26004
+ format: 'float',
26005
+ maximum: 1,
26006
+ minimum: 0,
26007
+ type: 'number',
26008
+ 'x-deprecated':
26009
+ "Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.",
26005
26010
  },
26006
26011
  connected_account_custom_metadata: {
26007
26012
  additionalProperties: {
@@ -26027,6 +26032,14 @@ const openapi: OpenAPISpec = {
26027
26032
  'The customer key associated with the device, if any.',
26028
26033
  type: 'string',
26029
26034
  },
26035
+ device_battery_level: {
26036
+ description:
26037
+ "Number in the range 0 to 1.0 indicating the affected device's own battery level, when known.",
26038
+ format: 'float',
26039
+ maximum: 1,
26040
+ minimum: 0,
26041
+ type: 'number',
26042
+ },
26030
26043
  device_custom_metadata: {
26031
26044
  additionalProperties: {
26032
26045
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
@@ -13627,7 +13627,7 @@ export type Routes = {
13627
13627
  starts_at: string
13628
13628
  /** Date and time at which the Access Grant ends. */
13629
13629
  ends_at: string | null
13630
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
13630
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
13631
13631
  display_status: string
13632
13632
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
13633
13633
  warnings: (
@@ -13857,7 +13857,7 @@ export type Routes = {
13857
13857
  starts_at: string
13858
13858
  /** Date and time at which the Access Grant ends. */
13859
13859
  ends_at: string | null
13860
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
13860
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
13861
13861
  display_status: string
13862
13862
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
13863
13863
  warnings: (
@@ -17204,7 +17204,7 @@ export type Routes = {
17204
17204
  starts_at: string
17205
17205
  /** Date and time at which the Access Grant ends. */
17206
17206
  ends_at: string | null
17207
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
17207
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
17208
17208
  display_status: string
17209
17209
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
17210
17210
  warnings: (
@@ -17434,7 +17434,7 @@ export type Routes = {
17434
17434
  starts_at: string
17435
17435
  /** Date and time at which the Access Grant ends. */
17436
17436
  ends_at: string | null
17437
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
17437
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
17438
17438
  display_status: string
17439
17439
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
17440
17440
  warnings: (
@@ -24750,7 +24750,7 @@ export type Routes = {
24750
24750
  starts_at: string
24751
24751
  /** Date and time at which the Access Grant ends. */
24752
24752
  ends_at: string | null
24753
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
24753
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
24754
24754
  display_status: string
24755
24755
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
24756
24756
  warnings: (
@@ -60500,10 +60500,13 @@ export type Routes = {
60500
60500
  }
60501
60501
  | undefined
60502
60502
  event_type: 'device.low_battery'
60503
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
60503
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
60504
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
60504
60505
  battery_level: number
60505
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
60506
- battery_source?: ('lock' | 'accessory_keypad') | undefined
60506
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
60507
+ device_battery_level?: number | undefined
60508
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
60509
+ accessory_keypad_battery_level?: number | undefined
60507
60510
  }
60508
60511
  | {
60509
60512
  /** ID of the event. */
@@ -64791,10 +64794,13 @@ export type Routes = {
64791
64794
  }
64792
64795
  | undefined
64793
64796
  event_type: 'device.low_battery'
64794
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
64797
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
64798
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
64795
64799
  battery_level: number
64796
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
64797
- battery_source?: ('lock' | 'accessory_keypad') | undefined
64800
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
64801
+ device_battery_level?: number | undefined
64802
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
64803
+ accessory_keypad_battery_level?: number | undefined
64798
64804
  }
64799
64805
  | {
64800
64806
  /** ID of the event. */
@@ -96220,7 +96226,7 @@ export type Routes = {
96220
96226
  starts_at: string
96221
96227
  /** Date and time at which the Access Grant ends. */
96222
96228
  ends_at: string | null
96223
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
96229
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
96224
96230
  display_status: string
96225
96231
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
96226
96232
  warnings: (
@@ -102513,10 +102519,13 @@ export type Routes = {
102513
102519
  }
102514
102520
  | undefined
102515
102521
  event_type: 'device.low_battery'
102516
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
102522
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
102523
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
102517
102524
  battery_level: number
102518
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
102519
- battery_source?: ('lock' | 'accessory_keypad') | undefined
102525
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
102526
+ device_battery_level?: number | undefined
102527
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
102528
+ accessory_keypad_battery_level?: number | undefined
102520
102529
  }
102521
102530
  | {
102522
102531
  /** ID of the event. */
@@ -104359,7 +104368,7 @@ export type Routes = {
104359
104368
  starts_at: string
104360
104369
  /** Date and time at which the Access Grant ends. */
104361
104370
  ends_at: string | null
104362
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
104371
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
104363
104372
  display_status: string
104364
104373
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
104365
104374
  warnings: (
@@ -104918,7 +104927,7 @@ export type Routes = {
104918
104927
  starts_at: string
104919
104928
  /** Date and time at which the Access Grant ends. */
104920
104929
  ends_at: string | null
104921
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
104930
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
104922
104931
  display_status: string
104923
104932
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
104924
104933
  warnings: (
@@ -146902,7 +146911,7 @@ export type Routes = {
146902
146911
  starts_at: string
146903
146912
  /** Date and time at which the Access Grant ends. */
146904
146913
  ends_at: string | null
146905
- /** Human-readable sentence answering whether the user can currently get in, for example `Awaiting encoding` on an access method or `Upcoming` here. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
146914
+ /** Human-readable sentence answering whether the user can currently get in, for example `Active`, `Awaiting issuance`, or `Upcoming`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `starts_at`, `ends_at`, `errors`, and the access methods' own fields. */
146906
146915
  display_status: string
146907
146916
  /** Warnings associated with the [access grant](https://docs.seam.co/use-cases/granting-access). */
146908
146917
  warnings: (
@@ -150041,10 +150050,13 @@ export type Routes = {
150041
150050
  }
150042
150051
  | undefined
150043
150052
  event_type: 'device.low_battery'
150044
- /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
150053
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
150054
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
150045
150055
  battery_level: number
150046
- /** Battery that dropped below the low threshold. `lock`: the lock's own battery. `accessory_keypad`: a paired accessory keypad's battery. Omitted for events emitted before this field existed, which always refer to the lock's own battery. */
150047
- battery_source?: ('lock' | 'accessory_keypad') | undefined
150056
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
150057
+ device_battery_level?: number | undefined
150058
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
150059
+ accessory_keypad_battery_level?: number | undefined
150048
150060
  }
150049
150061
  | {
150050
150062
  /** ID of the event. */