@seamapi/types 1.813.0 → 1.815.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.
@@ -31196,6 +31196,8 @@ export type Routes = {
31196
31196
  } | undefined;
31197
31197
  /** Customer key by which you want to filter connected accounts. */
31198
31198
  customer_key?: string | undefined;
31199
+ /** ID of the space by which you want to filter connected accounts. */
31200
+ space_id?: string | undefined;
31199
31201
  /** String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`. */
31200
31202
  search?: string | undefined;
31201
31203
  /** Maximum number of records to return per page. */
@@ -38559,7 +38561,11 @@ export type Routes = {
38559
38561
  /** ID of the action attempt associated with the lock action. */
38560
38562
  action_attempt_id?: string | undefined;
38561
38563
  /** 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';
38564
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
38565
+ /**
38566
+ 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.
38567
+ */
38568
+ is_bluetooth_action?: boolean | undefined;
38563
38569
  } | {
38564
38570
  /** ID of the event. */
38565
38571
  event_id: string;
@@ -38591,7 +38597,7 @@ export type Routes = {
38591
38597
  /** ID of the action attempt associated with the unlock action. */
38592
38598
  action_attempt_id?: string | undefined;
38593
38599
  /** 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';
38600
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
38595
38601
  /**
38596
38602
  undocumented: Unreleased.
38597
38603
  ---
@@ -38616,6 +38622,10 @@ export type Routes = {
38616
38622
  ID of the ACS entrance associated with the unlock event.
38617
38623
  */
38618
38624
  acs_entrance_id?: string | undefined;
38625
+ /**
38626
+ 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.
38627
+ */
38628
+ is_bluetooth_action?: boolean | undefined;
38619
38629
  } | {
38620
38630
  /** ID of the event. */
38621
38631
  event_id: string;
@@ -41387,7 +41397,11 @@ export type Routes = {
41387
41397
  /** ID of the action attempt associated with the lock action. */
41388
41398
  action_attempt_id?: string | undefined;
41389
41399
  /** 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';
41400
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
41401
+ /**
41402
+ 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.
41403
+ */
41404
+ is_bluetooth_action?: boolean | undefined;
41391
41405
  } | {
41392
41406
  /** ID of the event. */
41393
41407
  event_id: string;
@@ -41419,7 +41433,7 @@ export type Routes = {
41419
41433
  /** ID of the action attempt associated with the unlock action. */
41420
41434
  action_attempt_id?: string | undefined;
41421
41435
  /** 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';
41436
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
41423
41437
  /**
41424
41438
  undocumented: Unreleased.
41425
41439
  ---
@@ -41444,6 +41458,10 @@ export type Routes = {
41444
41458
  ID of the ACS entrance associated with the unlock event.
41445
41459
  */
41446
41460
  acs_entrance_id?: string | undefined;
41461
+ /**
41462
+ 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.
41463
+ */
41464
+ is_bluetooth_action?: boolean | undefined;
41447
41465
  } | {
41448
41466
  /** ID of the event. */
41449
41467
  event_id: string;
@@ -66470,7 +66488,11 @@ export type Routes = {
66470
66488
  /** ID of the action attempt associated with the lock action. */
66471
66489
  action_attempt_id?: string | undefined;
66472
66490
  /** 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';
66491
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
66492
+ /**
66493
+ 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.
66494
+ */
66495
+ is_bluetooth_action?: boolean | undefined;
66474
66496
  } | {
66475
66497
  /** ID of the event. */
66476
66498
  event_id: string;
@@ -66502,7 +66524,7 @@ export type Routes = {
66502
66524
  /** ID of the action attempt associated with the unlock action. */
66503
66525
  action_attempt_id?: string | undefined;
66504
66526
  /** 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';
66527
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
66506
66528
  /**
66507
66529
  undocumented: Unreleased.
66508
66530
  ---
@@ -66527,6 +66549,10 @@ export type Routes = {
66527
66549
  ID of the ACS entrance associated with the unlock event.
66528
66550
  */
66529
66551
  acs_entrance_id?: string | undefined;
66552
+ /**
66553
+ 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.
66554
+ */
66555
+ is_bluetooth_action?: boolean | undefined;
66530
66556
  } | {
66531
66557
  /** ID of the event. */
66532
66558
  event_id: string;
@@ -98888,7 +98914,11 @@ export type Routes = {
98888
98914
  /** ID of the action attempt associated with the lock action. */
98889
98915
  action_attempt_id?: string | undefined;
98890
98916
  /** 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';
98917
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
98918
+ /**
98919
+ 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.
98920
+ */
98921
+ is_bluetooth_action?: boolean | undefined;
98892
98922
  } | {
98893
98923
  /** ID of the event. */
98894
98924
  event_id: string;
@@ -98920,7 +98950,7 @@ export type Routes = {
98920
98950
  /** ID of the action attempt associated with the unlock action. */
98921
98951
  action_attempt_id?: string | undefined;
98922
98952
  /** 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';
98953
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote';
98924
98954
  /**
98925
98955
  undocumented: Unreleased.
98926
98956
  ---
@@ -98945,6 +98975,10 @@ export type Routes = {
98945
98975
  ID of the ACS entrance associated with the unlock event.
98946
98976
  */
98947
98977
  acs_entrance_id?: string | undefined;
98978
+ /**
98979
+ 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.
98980
+ */
98981
+ is_bluetooth_action?: boolean | undefined;
98948
98982
  } | {
98949
98983
  /** ID of the event. */
98950
98984
  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.815.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: {
@@ -50160,6 +50170,16 @@ export default {
50160
50170
  type: 'string',
50161
50171
  },
50162
50172
  },
50173
+ {
50174
+ in: 'query',
50175
+ name: 'space_id',
50176
+ schema: {
50177
+ description:
50178
+ 'ID of the space by which you want to filter connected accounts.',
50179
+ format: 'uuid',
50180
+ type: 'string',
50181
+ },
50182
+ },
50163
50183
  {
50164
50184
  in: 'query',
50165
50185
  name: 'search',
@@ -50271,6 +50291,12 @@ export default {
50271
50291
  minLength: 1,
50272
50292
  type: 'string',
50273
50293
  },
50294
+ space_id: {
50295
+ description:
50296
+ 'ID of the space by which you want to filter connected accounts.',
50297
+ format: 'uuid',
50298
+ type: 'string',
50299
+ },
50274
50300
  user_identifier_key: {
50275
50301
  description:
50276
50302
  'Your user ID for the user by which you want to filter connected accounts.',
@@ -36138,6 +36138,8 @@ export type Routes = {
36138
36138
  | undefined
36139
36139
  /** Customer key by which you want to filter connected accounts. */
36140
36140
  customer_key?: string | undefined
36141
+ /** ID of the space by which you want to filter connected accounts. */
36142
+ space_id?: string | undefined
36141
36143
  /** String for which to search. Filters returned connected accounts to include all records that satisfy a partial match using `connected_account_id`, `account_type`, `customer_key`, `custom_metadata`, `user_identifier.username`, `user_identifier.email` or `user_identifier.phone`. */
36142
36144
  search?: string | undefined
36143
36145
  /** Maximum number of records to return per page. */
@@ -46096,7 +46098,11 @@ export type Routes = {
46096
46098
  | 'manual'
46097
46099
  | 'automatic'
46098
46100
  | 'unknown'
46099
- | 'seamapi'
46101
+ | 'remote'
46102
+ /**
46103
+ 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.
46104
+ */
46105
+ is_bluetooth_action?: boolean | undefined
46100
46106
  }
46101
46107
  | {
46102
46108
  /** ID of the event. */
@@ -46138,7 +46144,7 @@ export type Routes = {
46138
46144
  | 'manual'
46139
46145
  | 'automatic'
46140
46146
  | 'unknown'
46141
- | 'seamapi'
46147
+ | 'remote'
46142
46148
  /**
46143
46149
  undocumented: Unreleased.
46144
46150
  ---
@@ -46163,6 +46169,10 @@ export type Routes = {
46163
46169
  ID of the ACS entrance associated with the unlock event.
46164
46170
  */
46165
46171
  acs_entrance_id?: string | undefined
46172
+ /**
46173
+ 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.
46174
+ */
46175
+ is_bluetooth_action?: boolean | undefined
46166
46176
  }
46167
46177
  | {
46168
46178
  /** ID of the event. */
@@ -49493,7 +49503,11 @@ export type Routes = {
49493
49503
  /** ID of the action attempt associated with the lock action. */
49494
49504
  action_attempt_id?: string | undefined
49495
49505
  /** 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'
49506
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
49507
+ /**
49508
+ 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.
49509
+ */
49510
+ is_bluetooth_action?: boolean | undefined
49497
49511
  }
49498
49512
  | {
49499
49513
  /** ID of the event. */
@@ -49530,7 +49544,7 @@ export type Routes = {
49530
49544
  /** ID of the action attempt associated with the unlock action. */
49531
49545
  action_attempt_id?: string | undefined
49532
49546
  /** 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'
49547
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
49534
49548
  /**
49535
49549
  undocumented: Unreleased.
49536
49550
  ---
@@ -49555,6 +49569,10 @@ export type Routes = {
49555
49569
  ID of the ACS entrance associated with the unlock event.
49556
49570
  */
49557
49571
  acs_entrance_id?: string | undefined
49572
+ /**
49573
+ 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.
49574
+ */
49575
+ is_bluetooth_action?: boolean | undefined
49558
49576
  }
49559
49577
  | {
49560
49578
  /** ID of the event. */
@@ -79437,7 +79455,11 @@ export type Routes = {
79437
79455
  /** ID of the action attempt associated with the lock action. */
79438
79456
  action_attempt_id?: string | undefined
79439
79457
  /** 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'
79458
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
79459
+ /**
79460
+ 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.
79461
+ */
79462
+ is_bluetooth_action?: boolean | undefined
79441
79463
  }
79442
79464
  | {
79443
79465
  /** ID of the event. */
@@ -79474,7 +79496,7 @@ export type Routes = {
79474
79496
  /** ID of the action attempt associated with the unlock action. */
79475
79497
  action_attempt_id?: string | undefined
79476
79498
  /** 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'
79499
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote'
79478
79500
  /**
79479
79501
  undocumented: Unreleased.
79480
79502
  ---
@@ -79499,6 +79521,10 @@ export type Routes = {
79499
79521
  ID of the ACS entrance associated with the unlock event.
79500
79522
  */
79501
79523
  acs_entrance_id?: string | undefined
79524
+ /**
79525
+ 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.
79526
+ */
79527
+ is_bluetooth_action?: boolean | undefined
79502
79528
  }
79503
79529
  | {
79504
79530
  /** ID of the event. */
@@ -117745,7 +117771,11 @@ export type Routes = {
117745
117771
  | 'manual'
117746
117772
  | 'automatic'
117747
117773
  | 'unknown'
117748
- | 'seamapi'
117774
+ | 'remote'
117775
+ /**
117776
+ 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.
117777
+ */
117778
+ is_bluetooth_action?: boolean | undefined
117749
117779
  }
117750
117780
  | {
117751
117781
  /** ID of the event. */
@@ -117787,7 +117817,7 @@ export type Routes = {
117787
117817
  | 'manual'
117788
117818
  | 'automatic'
117789
117819
  | 'unknown'
117790
- | 'seamapi'
117820
+ | 'remote'
117791
117821
  /**
117792
117822
  undocumented: Unreleased.
117793
117823
  ---
@@ -117812,6 +117842,10 @@ export type Routes = {
117812
117842
  ID of the ACS entrance associated with the unlock event.
117813
117843
  */
117814
117844
  acs_entrance_id?: string | undefined
117845
+ /**
117846
+ 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.
117847
+ */
117848
+ is_bluetooth_action?: boolean | undefined
117815
117849
  }
117816
117850
  | {
117817
117851
  /** ID of the event. */