@seamapi/types 1.1057.0 → 1.1058.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.
@@ -50718,7 +50718,7 @@ export type Routes = {
50718
50718
  /** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
50719
50719
  action_attempt_id?: string | undefined;
50720
50720
  /** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
50721
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
50721
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
50722
50722
  /** ID of the user identity associated with the lock event. */
50723
50723
  user_identity_id?: string | undefined;
50724
50724
  /** ID of the ACS system associated with the lock event. */
@@ -50772,7 +50772,7 @@ export type Routes = {
50772
50772
  /** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
50773
50773
  action_attempt_id?: string | undefined;
50774
50774
  /** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
50775
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
50775
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
50776
50776
  /** ID of the user identity associated with the unlock event. */
50777
50777
  user_identity_id?: string | undefined;
50778
50778
  /** ID of the ACS system associated with the unlock event. */
@@ -54349,7 +54349,7 @@ export type Routes = {
54349
54349
  /** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
54350
54350
  action_attempt_id?: string | undefined;
54351
54351
  /** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
54352
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
54352
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
54353
54353
  /** ID of the user identity associated with the lock event. */
54354
54354
  user_identity_id?: string | undefined;
54355
54355
  /** ID of the ACS system associated with the lock event. */
@@ -54403,7 +54403,7 @@ export type Routes = {
54403
54403
  /** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
54404
54404
  action_attempt_id?: string | undefined;
54405
54405
  /** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
54406
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
54406
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
54407
54407
  /** ID of the user identity associated with the unlock event. */
54408
54408
  user_identity_id?: string | undefined;
54409
54409
  /** ID of the ACS system associated with the unlock event. */
@@ -86150,7 +86150,7 @@ export type Routes = {
86150
86150
  /** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
86151
86151
  action_attempt_id?: string | undefined;
86152
86152
  /** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
86153
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
86153
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
86154
86154
  /** ID of the user identity associated with the lock event. */
86155
86155
  user_identity_id?: string | undefined;
86156
86156
  /** ID of the ACS system associated with the lock event. */
@@ -86204,7 +86204,7 @@ export type Routes = {
86204
86204
  /** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
86205
86205
  action_attempt_id?: string | undefined;
86206
86206
  /** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
86207
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
86207
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
86208
86208
  /** ID of the user identity associated with the unlock event. */
86209
86209
  user_identity_id?: string | undefined;
86210
86210
  /** ID of the ACS system associated with the unlock event. */
@@ -126310,7 +126310,7 @@ export type Routes = {
126310
126310
  /** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
126311
126311
  action_attempt_id?: string | undefined;
126312
126312
  /** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
126313
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
126313
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
126314
126314
  /** ID of the user identity associated with the lock event. */
126315
126315
  user_identity_id?: string | undefined;
126316
126316
  /** ID of the ACS system associated with the lock event. */
@@ -126364,7 +126364,7 @@ export type Routes = {
126364
126364
  /** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
126365
126365
  action_attempt_id?: string | undefined;
126366
126366
  /** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
126367
- method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card';
126367
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card' | 'mobile_key';
126368
126368
  /** ID of the user identity associated with the unlock event. */
126369
126369
  user_identity_id?: string | undefined;
126370
126370
  /** ID of the ACS system associated with the unlock event. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1057.0",
3
+ "version": "1.1058.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -81,9 +81,17 @@ const device_event_issue_properties = {
81
81
  }
82
82
 
83
83
  export const lock_method = z
84
- .enum(['keycode', 'manual', 'automatic', 'unknown', 'remote', 'card'])
84
+ .enum([
85
+ 'keycode',
86
+ 'manual',
87
+ 'automatic',
88
+ 'unknown',
89
+ 'remote',
90
+ 'card',
91
+ 'mobile_key',
92
+ ])
85
93
  .describe(
86
- 'Method by which the affected lock device was locked or unlocked. `keycode`: locked or unlocked using an access code (see `access_code_id`). `manual`: a direct physical action, such as turning a thumbturn or pressing a button. `remote`: a remote action initiated via an app, Bluetooth, or the Seam API (see `action_attempt_id` for Seam-initiated actions; see `is_via_bluetooth` or `is_via_nfc` for the specific transport). `automatic`: triggered automatically without user interaction, for example by an auto-relock timer. `card`: a physical credential (RFID card or NFC wallet pass) was presented at the reader. `unknown`: the method could not be determined from the provider event.',
94
+ "Method by which the affected lock device was locked or unlocked. `keycode`: locked or unlocked using an access code (see `access_code_id`). `manual`: a direct physical action, such as turning a thumbturn or pressing a button. `remote`: a remote action initiated via an app, Bluetooth, or the Seam API (see `action_attempt_id` for Seam-initiated actions; see `is_via_bluetooth` or `is_via_nfc` for the specific transport). `automatic`: triggered automatically without user interaction, for example by an auto-relock timer. `card`: a physical credential (RFID card or NFC wallet pass) was presented at the reader. `mobile_key`: a phone-based mobile credential in the provider's app was presented at the lock (see `is_via_bluetooth` or `is_via_nfc` for the transport). `unknown`: the method could not be determined from the provider event.",
87
95
  )
88
96
  export type LockMethod = z.infer<typeof lock_method>
89
97
 
@@ -27728,6 +27728,7 @@ const openapi: OpenAPISpec = {
27728
27728
  'unknown',
27729
27729
  'remote',
27730
27730
  'card',
27731
+ 'mobile_key',
27731
27732
  ],
27732
27733
  type: 'string',
27733
27734
  },
@@ -27877,6 +27878,7 @@ const openapi: OpenAPISpec = {
27877
27878
  'unknown',
27878
27879
  'remote',
27879
27880
  'card',
27881
+ 'mobile_key',
27880
27882
  ],
27881
27883
  type: 'string',
27882
27884
  },
@@ -61259,6 +61259,7 @@ export type Routes = {
61259
61259
  | 'unknown'
61260
61260
  | 'remote'
61261
61261
  | 'card'
61262
+ | 'mobile_key'
61262
61263
  /** ID of the user identity associated with the lock event. */
61263
61264
  user_identity_id?: string | undefined
61264
61265
  /** ID of the ACS system associated with the lock event. */
@@ -61324,6 +61325,7 @@ export type Routes = {
61324
61325
  | 'unknown'
61325
61326
  | 'remote'
61326
61327
  | 'card'
61328
+ | 'mobile_key'
61327
61329
  /** ID of the user identity associated with the unlock event. */
61328
61330
  user_identity_id?: string | undefined
61329
61331
  /** ID of the ACS system associated with the unlock event. */
@@ -65547,7 +65549,13 @@ export type Routes = {
65547
65549
  action_attempt_id?: string | undefined
65548
65550
  /** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
65549
65551
  method:
65550
- 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card'
65552
+ | 'keycode'
65553
+ | 'manual'
65554
+ | 'automatic'
65555
+ | 'unknown'
65556
+ | 'remote'
65557
+ | 'card'
65558
+ | 'mobile_key'
65551
65559
  /** ID of the user identity associated with the lock event. */
65552
65560
  user_identity_id?: string | undefined
65553
65561
  /** ID of the ACS system associated with the lock event. */
@@ -65607,7 +65615,13 @@ export type Routes = {
65607
65615
  action_attempt_id?: string | undefined
65608
65616
  /** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
65609
65617
  method:
65610
- 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card'
65618
+ | 'keycode'
65619
+ | 'manual'
65620
+ | 'automatic'
65621
+ | 'unknown'
65622
+ | 'remote'
65623
+ | 'card'
65624
+ | 'mobile_key'
65611
65625
  /** ID of the user identity associated with the unlock event. */
65612
65626
  user_identity_id?: string | undefined
65613
65627
  /** ID of the ACS system associated with the unlock event. */
@@ -103399,7 +103413,13 @@ export type Routes = {
103399
103413
  action_attempt_id?: string | undefined
103400
103414
  /** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
103401
103415
  method:
103402
- 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card'
103416
+ | 'keycode'
103417
+ | 'manual'
103418
+ | 'automatic'
103419
+ | 'unknown'
103420
+ | 'remote'
103421
+ | 'card'
103422
+ | 'mobile_key'
103403
103423
  /** ID of the user identity associated with the lock event. */
103404
103424
  user_identity_id?: string | undefined
103405
103425
  /** ID of the ACS system associated with the lock event. */
@@ -103459,7 +103479,13 @@ export type Routes = {
103459
103479
  action_attempt_id?: string | undefined
103460
103480
  /** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
103461
103481
  method:
103462
- 'keycode' | 'manual' | 'automatic' | 'unknown' | 'remote' | 'card'
103482
+ | 'keycode'
103483
+ | 'manual'
103484
+ | 'automatic'
103485
+ | 'unknown'
103486
+ | 'remote'
103487
+ | 'card'
103488
+ | 'mobile_key'
103463
103489
  /** ID of the user identity associated with the unlock event. */
103464
103490
  user_identity_id?: string | undefined
103465
103491
  /** ID of the ACS system associated with the unlock event. */
@@ -151118,6 +151144,7 @@ export type Routes = {
151118
151144
  | 'unknown'
151119
151145
  | 'remote'
151120
151146
  | 'card'
151147
+ | 'mobile_key'
151121
151148
  /** ID of the user identity associated with the lock event. */
151122
151149
  user_identity_id?: string | undefined
151123
151150
  /** ID of the ACS system associated with the lock event. */
@@ -151183,6 +151210,7 @@ export type Routes = {
151183
151210
  | 'unknown'
151184
151211
  | 'remote'
151185
151212
  | 'card'
151213
+ | 'mobile_key'
151186
151214
  /** ID of the user identity associated with the unlock event. */
151187
151215
  user_identity_id?: string | undefined
151188
151216
  /** ID of the ACS system associated with the unlock event. */