@seamapi/types 1.813.0 → 1.814.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.
@@ -38559,7 +38559,11 @@ export type Routes = {
38559
38559
  /** ID of the action attempt associated with the lock action. */
38560
38560
  action_attempt_id?: string | undefined;
38561
38561
  /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
38562
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
38562
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
38563
+ /**
38564
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
38565
+ */
38566
+ is_bluetooth_action?: boolean | undefined;
38563
38567
  } | {
38564
38568
  /** ID of the event. */
38565
38569
  event_id: string;
@@ -38591,7 +38595,7 @@ export type Routes = {
38591
38595
  /** ID of the action attempt associated with the unlock action. */
38592
38596
  action_attempt_id?: string | undefined;
38593
38597
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
38594
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
38598
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
38595
38599
  /**
38596
38600
  undocumented: Unreleased.
38597
38601
  ---
@@ -38616,6 +38620,10 @@ export type Routes = {
38616
38620
  ID of the ACS entrance associated with the unlock event.
38617
38621
  */
38618
38622
  acs_entrance_id?: string | undefined;
38623
+ /**
38624
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
38625
+ */
38626
+ is_bluetooth_action?: boolean | undefined;
38619
38627
  } | {
38620
38628
  /** ID of the event. */
38621
38629
  event_id: string;
@@ -41387,7 +41395,11 @@ export type Routes = {
41387
41395
  /** ID of the action attempt associated with the lock action. */
41388
41396
  action_attempt_id?: string | undefined;
41389
41397
  /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
41390
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
41398
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
41399
+ /**
41400
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
41401
+ */
41402
+ is_bluetooth_action?: boolean | undefined;
41391
41403
  } | {
41392
41404
  /** ID of the event. */
41393
41405
  event_id: string;
@@ -41419,7 +41431,7 @@ export type Routes = {
41419
41431
  /** ID of the action attempt associated with the unlock action. */
41420
41432
  action_attempt_id?: string | undefined;
41421
41433
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
41422
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
41434
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
41423
41435
  /**
41424
41436
  undocumented: Unreleased.
41425
41437
  ---
@@ -41444,6 +41456,10 @@ export type Routes = {
41444
41456
  ID of the ACS entrance associated with the unlock event.
41445
41457
  */
41446
41458
  acs_entrance_id?: string | undefined;
41459
+ /**
41460
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
41461
+ */
41462
+ is_bluetooth_action?: boolean | undefined;
41447
41463
  } | {
41448
41464
  /** ID of the event. */
41449
41465
  event_id: string;
@@ -66470,7 +66486,11 @@ export type Routes = {
66470
66486
  /** ID of the action attempt associated with the lock action. */
66471
66487
  action_attempt_id?: string | undefined;
66472
66488
  /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
66473
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
66489
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
66490
+ /**
66491
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
66492
+ */
66493
+ is_bluetooth_action?: boolean | undefined;
66474
66494
  } | {
66475
66495
  /** ID of the event. */
66476
66496
  event_id: string;
@@ -66502,7 +66522,7 @@ export type Routes = {
66502
66522
  /** ID of the action attempt associated with the unlock action. */
66503
66523
  action_attempt_id?: string | undefined;
66504
66524
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
66505
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
66525
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
66506
66526
  /**
66507
66527
  undocumented: Unreleased.
66508
66528
  ---
@@ -66527,6 +66547,10 @@ export type Routes = {
66527
66547
  ID of the ACS entrance associated with the unlock event.
66528
66548
  */
66529
66549
  acs_entrance_id?: string | undefined;
66550
+ /**
66551
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
66552
+ */
66553
+ is_bluetooth_action?: boolean | undefined;
66530
66554
  } | {
66531
66555
  /** ID of the event. */
66532
66556
  event_id: string;
@@ -98888,7 +98912,11 @@ export type Routes = {
98888
98912
  /** ID of the action attempt associated with the lock action. */
98889
98913
  action_attempt_id?: string | undefined;
98890
98914
  /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
98891
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
98915
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
98916
+ /**
98917
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
98918
+ */
98919
+ is_bluetooth_action?: boolean | undefined;
98892
98920
  } | {
98893
98921
  /** ID of the event. */
98894
98922
  event_id: string;
@@ -98920,7 +98948,7 @@ export type Routes = {
98920
98948
  /** ID of the action attempt associated with the unlock action. */
98921
98949
  action_attempt_id?: string | undefined;
98922
98950
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
98923
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi';
98951
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
98924
98952
  /**
98925
98953
  undocumented: Unreleased.
98926
98954
  ---
@@ -98945,6 +98973,10 @@ export type Routes = {
98945
98973
  ID of the ACS entrance associated with the unlock event.
98946
98974
  */
98947
98975
  acs_entrance_id?: string | undefined;
98976
+ /**
98977
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
98978
+ */
98979
+ is_bluetooth_action?: boolean | undefined;
98948
98980
  } | {
98949
98981
  /** ID of the event. */
98950
98982
  event_id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.813.0",
3
+ "version": "1.814.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -66,9 +66,9 @@ const device_event_issue_properties = {
66
66
  }
67
67
 
68
68
  export const lock_method = z
69
- .enum(['keycode', 'manual', 'automatic', 'unknown', 'seamapi'])
69
+ .enum(['keycode', 'manual', 'automatic', 'unknown', 'remote'])
70
70
  .describe(
71
- 'Method by which the affected lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
71
+ 'Method by which the affected lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. The `remote` method indicates any remote (un)lock action, including Bluetooth, mobile app, or Seam API. For Seam-initiated remote (un)locks, look up the `action_attempt_id`.',
72
72
  )
73
73
  export type LockMethod = z.infer<typeof lock_method>
74
74
 
@@ -424,6 +424,9 @@ export const lock_locked_event = device_event.extend({
424
424
  method: lock_method.describe(
425
425
  'Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
426
426
  ),
427
+ is_bluetooth_action: z.boolean().optional().describe(`
428
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
429
+ `),
427
430
  }).describe(`
428
431
  ---
429
432
  route_path: /locks
@@ -481,6 +484,9 @@ export const lock_unlocked_event = device_event.extend({
481
484
  .uuid()
482
485
  .optional()
483
486
  .describe('ID of the affected device.'),
487
+ is_bluetooth_action: z.boolean().optional().describe(`
488
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
489
+ `),
484
490
  }).describe(`
485
491
  ---
486
492
  route_path: /locks
@@ -22973,10 +22973,15 @@ export default {
22973
22973
  type: 'string',
22974
22974
  },
22975
22975
  event_type: { enum: ['lock.locked'], type: 'string' },
22976
+ is_bluetooth_action: {
22977
+ description:
22978
+ "\n Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ",
22979
+ type: 'boolean',
22980
+ },
22976
22981
  method: {
22977
22982
  description:
22978
22983
  'Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device.',
22979
- enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
22984
+ enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
22980
22985
  type: 'string',
22981
22986
  },
22982
22987
  occurred_at: {
@@ -23086,10 +23091,15 @@ export default {
23086
23091
  type: 'string',
23087
23092
  },
23088
23093
  event_type: { enum: ['lock.unlocked'], type: 'string' },
23094
+ is_bluetooth_action: {
23095
+ description:
23096
+ "\n Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.\n ",
23097
+ type: 'boolean',
23098
+ },
23089
23099
  method: {
23090
23100
  description:
23091
23101
  'Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.',
23092
- enum: ['keycode', 'manual', 'automatic', 'unknown', 'seamapi'],
23102
+ enum: ['keycode', 'manual', 'automatic', 'unknown', 'remote'],
23093
23103
  type: 'string',
23094
23104
  },
23095
23105
  occurred_at: {
@@ -46096,7 +46096,11 @@ export type Routes = {
46096
46096
  | 'manual'
46097
46097
  | 'automatic'
46098
46098
  | 'unknown'
46099
- | 'seamapi'
46099
+ | 'remote'
46100
+ /**
46101
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
46102
+ */
46103
+ is_bluetooth_action?: boolean | undefined
46100
46104
  }
46101
46105
  | {
46102
46106
  /** ID of the event. */
@@ -46138,7 +46142,7 @@ export type Routes = {
46138
46142
  | 'manual'
46139
46143
  | 'automatic'
46140
46144
  | 'unknown'
46141
- | 'seamapi'
46145
+ | 'remote'
46142
46146
  /**
46143
46147
  undocumented: Unreleased.
46144
46148
  ---
@@ -46163,6 +46167,10 @@ export type Routes = {
46163
46167
  ID of the ACS entrance associated with the unlock event.
46164
46168
  */
46165
46169
  acs_entrance_id?: string | undefined
46170
+ /**
46171
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
46172
+ */
46173
+ is_bluetooth_action?: boolean | undefined
46166
46174
  }
46167
46175
  | {
46168
46176
  /** ID of the event. */
@@ -49493,7 +49501,11 @@ export type Routes = {
49493
49501
  /** ID of the action attempt associated with the lock action. */
49494
49502
  action_attempt_id?: string | undefined
49495
49503
  /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
49496
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
49504
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
49505
+ /**
49506
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
49507
+ */
49508
+ is_bluetooth_action?: boolean | undefined
49497
49509
  }
49498
49510
  | {
49499
49511
  /** ID of the event. */
@@ -49530,7 +49542,7 @@ export type Routes = {
49530
49542
  /** ID of the action attempt associated with the unlock action. */
49531
49543
  action_attempt_id?: string | undefined
49532
49544
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
49533
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
49545
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
49534
49546
  /**
49535
49547
  undocumented: Unreleased.
49536
49548
  ---
@@ -49555,6 +49567,10 @@ export type Routes = {
49555
49567
  ID of the ACS entrance associated with the unlock event.
49556
49568
  */
49557
49569
  acs_entrance_id?: string | undefined
49570
+ /**
49571
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
49572
+ */
49573
+ is_bluetooth_action?: boolean | undefined
49558
49574
  }
49559
49575
  | {
49560
49576
  /** ID of the event. */
@@ -79437,7 +79453,11 @@ export type Routes = {
79437
79453
  /** ID of the action attempt associated with the lock action. */
79438
79454
  action_attempt_id?: string | undefined
79439
79455
  /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
79440
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
79456
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
79457
+ /**
79458
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
79459
+ */
79460
+ is_bluetooth_action?: boolean | undefined
79441
79461
  }
79442
79462
  | {
79443
79463
  /** ID of the event. */
@@ -79474,7 +79494,7 @@ export type Routes = {
79474
79494
  /** ID of the action attempt associated with the unlock action. */
79475
79495
  action_attempt_id?: string | undefined
79476
79496
  /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
79477
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
79497
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
79478
79498
  /**
79479
79499
  undocumented: Unreleased.
79480
79500
  ---
@@ -79499,6 +79519,10 @@ export type Routes = {
79499
79519
  ID of the ACS entrance associated with the unlock event.
79500
79520
  */
79501
79521
  acs_entrance_id?: string | undefined
79522
+ /**
79523
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
79524
+ */
79525
+ is_bluetooth_action?: boolean | undefined
79502
79526
  }
79503
79527
  | {
79504
79528
  /** ID of the event. */
@@ -117745,7 +117769,11 @@ export type Routes = {
117745
117769
  | 'manual'
117746
117770
  | 'automatic'
117747
117771
  | 'unknown'
117748
- | 'seamapi'
117772
+ | 'remote'
117773
+ /**
117774
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
117775
+ */
117776
+ is_bluetooth_action?: boolean | undefined
117749
117777
  }
117750
117778
  | {
117751
117779
  /** ID of the event. */
@@ -117787,7 +117815,7 @@ export type Routes = {
117787
117815
  | 'manual'
117788
117816
  | 'automatic'
117789
117817
  | 'unknown'
117790
- | 'seamapi'
117818
+ | 'remote'
117791
117819
  /**
117792
117820
  undocumented: Unreleased.
117793
117821
  ---
@@ -117812,6 +117840,10 @@ export type Routes = {
117812
117840
  ID of the ACS entrance associated with the unlock event.
117813
117841
  */
117814
117842
  acs_entrance_id?: string | undefined
117843
+ /**
117844
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
117845
+ */
117846
+ is_bluetooth_action?: boolean | undefined
117815
117847
  }
117816
117848
  | {
117817
117849
  /** ID of the event. */