@seamapi/types 1.1054.0 → 1.1056.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.
Files changed (24) hide show
  1. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +3 -0
  2. package/lib/seam/connect/models/access-codes/managed-access-code.js +9 -3
  3. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  4. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +3 -0
  5. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +9 -3
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  7. package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -3
  8. package/lib/seam/connect/models/access-grants/access-method.d.ts +4 -4
  9. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +4 -4
  10. package/lib/seam/connect/models/action-attempts/assign-credential.d.ts +4 -4
  11. package/lib/seam/connect/models/devices/device-metadata.d.ts +14 -14
  12. package/lib/seam/connect/models/devices/device-metadata.js +2 -2
  13. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  14. package/lib/seam/connect/models/devices/device.d.ts +18 -18
  15. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +14 -14
  16. package/lib/seam/connect/openapi.js +16 -2
  17. package/lib/seam/connect/openapi.js.map +1 -1
  18. package/lib/seam/connect/route-types.d.ts +78 -45
  19. package/package.json +1 -1
  20. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +9 -3
  21. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +9 -3
  22. package/src/lib/seam/connect/models/devices/device-metadata.ts +2 -2
  23. package/src/lib/seam/connect/openapi.ts +20 -2
  24. package/src/lib/seam/connect/route-types.ts +112 -45
@@ -2562,8 +2562,11 @@ export type Routes = {
2562
2562
  starts_at?: (string | null) | undefined
2563
2563
  /** Date and time after which the time-bound access code becomes inactive. */
2564
2564
  ends_at?: (string | null) | undefined
2565
- /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). */
2565
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
2566
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.*/
2566
2567
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
2568
+ /** Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. 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 `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */
2569
+ display_status: string
2567
2570
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
2568
2571
  is_backup_access_code_available: boolean
2569
2572
  /** Indicates whether the access code is a backup code. */
@@ -3145,8 +3148,11 @@ export type Routes = {
3145
3148
  starts_at?: (string | null) | undefined
3146
3149
  /** Date and time after which the time-bound access code becomes inactive. */
3147
3150
  ends_at?: (string | null) | undefined
3148
- /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). */
3151
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
3152
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.*/
3149
3153
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
3154
+ /** Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. 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 `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */
3155
+ display_status: string
3150
3156
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
3151
3157
  is_backup_access_code_available: boolean
3152
3158
  /** Indicates whether the access code is a backup code. */
@@ -5836,8 +5842,11 @@ export type Routes = {
5836
5842
  starts_at?: (string | null) | undefined
5837
5843
  /** Date and time after which the time-bound access code becomes inactive. */
5838
5844
  ends_at?: (string | null) | undefined
5839
- /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). */
5845
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
5846
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.*/
5840
5847
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
5848
+ /** Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. 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 `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */
5849
+ display_status: string
5841
5850
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
5842
5851
  is_backup_access_code_available: boolean
5843
5852
  /** Indicates whether the access code is a backup code. */
@@ -6530,8 +6539,11 @@ export type Routes = {
6530
6539
  starts_at?: (string | null) | undefined
6531
6540
  /** Date and time after which the time-bound access code becomes inactive. */
6532
6541
  ends_at?: (string | null) | undefined
6533
- /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). */
6542
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
6543
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.*/
6534
6544
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
6545
+ /** Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. 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 `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */
6546
+ display_status: string
6535
6547
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
6536
6548
  is_backup_access_code_available: boolean
6537
6549
  /** Indicates whether the access code is a backup code. */
@@ -7104,8 +7116,11 @@ export type Routes = {
7104
7116
  starts_at?: (string | null) | undefined
7105
7117
  /** Date and time after which the time-bound access code becomes inactive. */
7106
7118
  ends_at?: (string | null) | undefined
7107
- /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). */
7119
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
7120
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.*/
7108
7121
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
7122
+ /** Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. 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 `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */
7123
+ display_status: string
7109
7124
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
7110
7125
  is_backup_access_code_available: boolean
7111
7126
  /** Indicates whether the access code is a backup code. */
@@ -7655,8 +7670,11 @@ export type Routes = {
7655
7670
  starts_at?: (string | null) | undefined
7656
7671
  /** Date and time after which the time-bound access code becomes inactive. */
7657
7672
  ends_at?: (string | null) | undefined
7658
- /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). */
7673
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
7674
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.*/
7659
7675
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
7676
+ /** Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. 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 `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */
7677
+ display_status: string
7660
7678
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
7661
7679
  is_backup_access_code_available: boolean
7662
7680
  /** Indicates whether the access code is a backup code. */
@@ -8239,8 +8257,11 @@ export type Routes = {
8239
8257
  starts_at?: (string | null) | undefined
8240
8258
  /** Date and time after which the time-bound access code becomes inactive. */
8241
8259
  ends_at?: (string | null) | undefined
8242
- /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
8260
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.
8261
+ * @deprecated Use `display_status` to show a person the code's state.*/
8243
8262
  status: 'set' | 'unset'
8263
+ /** Human-readable label for the code's state: `Active` or `Not active`, based on whether the code is set on the device. For display only. The wording is not stable and is not an enumeration — never compare against or branch on it. */
8264
+ display_status: string
8244
8265
  /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
8245
8266
  cannot_be_managed?: true | undefined
8246
8267
  /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
@@ -10832,8 +10853,11 @@ export type Routes = {
10832
10853
  starts_at?: (string | null) | undefined
10833
10854
  /** Date and time after which the time-bound access code becomes inactive. */
10834
10855
  ends_at?: (string | null) | undefined
10835
- /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
10856
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.
10857
+ * @deprecated Use `display_status` to show a person the code's state.*/
10836
10858
  status: 'set' | 'unset'
10859
+ /** Human-readable label for the code's state: `Active` or `Not active`, based on whether the code is set on the device. For display only. The wording is not stable and is not an enumeration — never compare against or branch on it. */
10860
+ display_status: string
10837
10861
  /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
10838
10862
  cannot_be_managed?: true | undefined
10839
10863
  /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
@@ -11295,8 +11319,11 @@ export type Routes = {
11295
11319
  starts_at?: (string | null) | undefined
11296
11320
  /** Date and time after which the time-bound access code becomes inactive. */
11297
11321
  ends_at?: (string | null) | undefined
11298
- /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
11322
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.
11323
+ * @deprecated Use `display_status` to show a person the code's state.*/
11299
11324
  status: 'set' | 'unset'
11325
+ /** Human-readable label for the code's state: `Active` or `Not active`, based on whether the code is set on the device. For display only. The wording is not stable and is not an enumeration — never compare against or branch on it. */
11326
+ display_status: string
11300
11327
  /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
11301
11328
  cannot_be_managed?: true | undefined
11302
11329
  /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
@@ -14766,8 +14793,10 @@ export type Routes = {
14766
14793
  userLevel?: (number | undefined) | undefined
14767
14794
  userLevelName?: (string | undefined) | undefined
14768
14795
  userLevelType?: (string | undefined) | undefined
14769
- checkInTime?: (string | undefined) | undefined
14770
- checkOutTime?: (string | undefined) | undefined
14796
+ userLevelCheckInTime?:
14797
+ (string | undefined) | undefined
14798
+ userLevelCheckOutTime?:
14799
+ (string | undefined) | undefined
14771
14800
  }[]
14772
14801
  | undefined
14773
14802
  )
@@ -23207,8 +23236,10 @@ export type Routes = {
23207
23236
  userLevel?: (number | undefined) | undefined
23208
23237
  userLevelName?: (string | undefined) | undefined
23209
23238
  userLevelType?: (string | undefined) | undefined
23210
- checkInTime?: (string | undefined) | undefined
23211
- checkOutTime?: (string | undefined) | undefined
23239
+ userLevelCheckInTime?:
23240
+ (string | undefined) | undefined
23241
+ userLevelCheckOutTime?:
23242
+ (string | undefined) | undefined
23212
23243
  }[]
23213
23244
  | undefined
23214
23245
  )
@@ -51366,8 +51397,10 @@ export type Routes = {
51366
51397
  userLevel?: (number | undefined) | undefined
51367
51398
  userLevelName?: (string | undefined) | undefined
51368
51399
  userLevelType?: (string | undefined) | undefined
51369
- checkInTime?: (string | undefined) | undefined
51370
- checkOutTime?: (string | undefined) | undefined
51400
+ userLevelCheckInTime?:
51401
+ (string | undefined) | undefined
51402
+ userLevelCheckOutTime?:
51403
+ (string | undefined) | undefined
51371
51404
  }[]
51372
51405
  | undefined
51373
51406
  )
@@ -53507,8 +53540,10 @@ export type Routes = {
53507
53540
  userLevel?: (number | undefined) | undefined
53508
53541
  userLevelName?: (string | undefined) | undefined
53509
53542
  userLevelType?: (string | undefined) | undefined
53510
- checkInTime?: (string | undefined) | undefined
53511
- checkOutTime?: (string | undefined) | undefined
53543
+ userLevelCheckInTime?:
53544
+ (string | undefined) | undefined
53545
+ userLevelCheckOutTime?:
53546
+ (string | undefined) | undefined
53512
53547
  }[]
53513
53548
  | undefined
53514
53549
  )
@@ -68980,8 +69015,10 @@ export type Routes = {
68980
69015
  userLevel?: (number | undefined) | undefined
68981
69016
  userLevelName?: (string | undefined) | undefined
68982
69017
  userLevelType?: (string | undefined) | undefined
68983
- checkInTime?: (string | undefined) | undefined
68984
- checkOutTime?: (string | undefined) | undefined
69018
+ userLevelCheckInTime?:
69019
+ (string | undefined) | undefined
69020
+ userLevelCheckOutTime?:
69021
+ (string | undefined) | undefined
68985
69022
  }[]
68986
69023
  | undefined
68987
69024
  )
@@ -70871,8 +70908,10 @@ export type Routes = {
70871
70908
  userLevel?: (number | undefined) | undefined
70872
70909
  userLevelName?: (string | undefined) | undefined
70873
70910
  userLevelType?: (string | undefined) | undefined
70874
- checkInTime?: (string | undefined) | undefined
70875
- checkOutTime?: (string | undefined) | undefined
70911
+ userLevelCheckInTime?:
70912
+ (string | undefined) | undefined
70913
+ userLevelCheckOutTime?:
70914
+ (string | undefined) | undefined
70876
70915
  }[]
70877
70916
  | undefined
70878
70917
  )
@@ -72890,8 +72929,10 @@ export type Routes = {
72890
72929
  userLevel?: (number | undefined) | undefined
72891
72930
  userLevelName?: (string | undefined) | undefined
72892
72931
  userLevelType?: (string | undefined) | undefined
72893
- checkInTime?: (string | undefined) | undefined
72894
- checkOutTime?: (string | undefined) | undefined
72932
+ userLevelCheckInTime?:
72933
+ (string | undefined) | undefined
72934
+ userLevelCheckOutTime?:
72935
+ (string | undefined) | undefined
72895
72936
  }[]
72896
72937
  | undefined
72897
72938
  )
@@ -74780,8 +74821,10 @@ export type Routes = {
74780
74821
  userLevel?: (number | undefined) | undefined
74781
74822
  userLevelName?: (string | undefined) | undefined
74782
74823
  userLevelType?: (string | undefined) | undefined
74783
- checkInTime?: (string | undefined) | undefined
74784
- checkOutTime?: (string | undefined) | undefined
74824
+ userLevelCheckInTime?:
74825
+ (string | undefined) | undefined
74826
+ userLevelCheckOutTime?:
74827
+ (string | undefined) | undefined
74785
74828
  }[]
74786
74829
  | undefined
74787
74830
  )
@@ -85100,8 +85143,10 @@ export type Routes = {
85100
85143
  userLevel?: (number | undefined) | undefined
85101
85144
  userLevelName?: (string | undefined) | undefined
85102
85145
  userLevelType?: (string | undefined) | undefined
85103
- checkInTime?: (string | undefined) | undefined
85104
- checkOutTime?: (string | undefined) | undefined
85146
+ userLevelCheckInTime?:
85147
+ (string | undefined) | undefined
85148
+ userLevelCheckOutTime?:
85149
+ (string | undefined) | undefined
85105
85150
  }[]
85106
85151
  | undefined
85107
85152
  )
@@ -86990,8 +87035,10 @@ export type Routes = {
86990
87035
  userLevel?: (number | undefined) | undefined
86991
87036
  userLevelName?: (string | undefined) | undefined
86992
87037
  userLevelType?: (string | undefined) | undefined
86993
- checkInTime?: (string | undefined) | undefined
86994
- checkOutTime?: (string | undefined) | undefined
87038
+ userLevelCheckInTime?:
87039
+ (string | undefined) | undefined
87040
+ userLevelCheckOutTime?:
87041
+ (string | undefined) | undefined
86995
87042
  }[]
86996
87043
  | undefined
86997
87044
  )
@@ -107292,8 +107339,10 @@ export type Routes = {
107292
107339
  userLevel?: (number | undefined) | undefined
107293
107340
  userLevelName?: (string | undefined) | undefined
107294
107341
  userLevelType?: (string | undefined) | undefined
107295
- checkInTime?: (string | undefined) | undefined
107296
- checkOutTime?: (string | undefined) | undefined
107342
+ userLevelCheckInTime?:
107343
+ (string | undefined) | undefined
107344
+ userLevelCheckOutTime?:
107345
+ (string | undefined) | undefined
107297
107346
  }[]
107298
107347
  | undefined
107299
107348
  )
@@ -116732,8 +116781,10 @@ export type Routes = {
116732
116781
  userLevel?: (number | undefined) | undefined
116733
116782
  userLevelName?: (string | undefined) | undefined
116734
116783
  userLevelType?: (string | undefined) | undefined
116735
- checkInTime?: (string | undefined) | undefined
116736
- checkOutTime?: (string | undefined) | undefined
116784
+ userLevelCheckInTime?:
116785
+ (string | undefined) | undefined
116786
+ userLevelCheckOutTime?:
116787
+ (string | undefined) | undefined
116737
116788
  }[]
116738
116789
  | undefined
116739
116790
  )
@@ -122889,8 +122940,10 @@ export type Routes = {
122889
122940
  userLevel?: (number | undefined) | undefined
122890
122941
  userLevelName?: (string | undefined) | undefined
122891
122942
  userLevelType?: (string | undefined) | undefined
122892
- checkInTime?: (string | undefined) | undefined
122893
- checkOutTime?: (string | undefined) | undefined
122943
+ userLevelCheckInTime?:
122944
+ (string | undefined) | undefined
122945
+ userLevelCheckOutTime?:
122946
+ (string | undefined) | undefined
122894
122947
  }[]
122895
122948
  | undefined
122896
122949
  )
@@ -124779,8 +124832,10 @@ export type Routes = {
124779
124832
  userLevel?: (number | undefined) | undefined
124780
124833
  userLevelName?: (string | undefined) | undefined
124781
124834
  userLevelType?: (string | undefined) | undefined
124782
- checkInTime?: (string | undefined) | undefined
124783
- checkOutTime?: (string | undefined) | undefined
124835
+ userLevelCheckInTime?:
124836
+ (string | undefined) | undefined
124837
+ userLevelCheckOutTime?:
124838
+ (string | undefined) | undefined
124784
124839
  }[]
124785
124840
  | undefined
124786
124841
  )
@@ -136123,8 +136178,10 @@ export type Routes = {
136123
136178
  userLevel?: (number | undefined) | undefined
136124
136179
  userLevelName?: (string | undefined) | undefined
136125
136180
  userLevelType?: (string | undefined) | undefined
136126
- checkInTime?: (string | undefined) | undefined
136127
- checkOutTime?: (string | undefined) | undefined
136181
+ userLevelCheckInTime?:
136182
+ (string | undefined) | undefined
136183
+ userLevelCheckOutTime?:
136184
+ (string | undefined) | undefined
136128
136185
  }[]
136129
136186
  | undefined
136130
136187
  )
@@ -138015,8 +138072,10 @@ export type Routes = {
138015
138072
  userLevel?: (number | undefined) | undefined
138016
138073
  userLevelName?: (string | undefined) | undefined
138017
138074
  userLevelType?: (string | undefined) | undefined
138018
- checkInTime?: (string | undefined) | undefined
138019
- checkOutTime?: (string | undefined) | undefined
138075
+ userLevelCheckInTime?:
138076
+ (string | undefined) | undefined
138077
+ userLevelCheckOutTime?:
138078
+ (string | undefined) | undefined
138020
138079
  }[]
138021
138080
  | undefined
138022
138081
  )
@@ -141460,8 +141519,10 @@ export type Routes = {
141460
141519
  userLevel?: (number | undefined) | undefined
141461
141520
  userLevelName?: (string | undefined) | undefined
141462
141521
  userLevelType?: (string | undefined) | undefined
141463
- checkInTime?: (string | undefined) | undefined
141464
- checkOutTime?: (string | undefined) | undefined
141522
+ userLevelCheckInTime?:
141523
+ (string | undefined) | undefined
141524
+ userLevelCheckOutTime?:
141525
+ (string | undefined) | undefined
141465
141526
  }[]
141466
141527
  | undefined
141467
141528
  )
@@ -152479,8 +152540,11 @@ export type Routes = {
152479
152540
  starts_at?: (string | null) | undefined
152480
152541
  /** Date and time after which the time-bound access code becomes inactive. */
152481
152542
  ends_at?: (string | null) | undefined
152482
- /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
152543
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.
152544
+ * @deprecated Use `display_status` to show a person the code's state.*/
152483
152545
  status: 'set' | 'unset'
152546
+ /** Human-readable label for the code's state: `Active` or `Not active`, based on whether the code is set on the device. For display only. The wording is not stable and is not an enumeration — never compare against or branch on it. */
152547
+ display_status: string
152484
152548
  /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
152485
152549
  cannot_be_managed?: true | undefined
152486
152550
  /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
@@ -152928,8 +152992,11 @@ export type Routes = {
152928
152992
  starts_at?: (string | null) | undefined
152929
152993
  /** Date and time after which the time-bound access code becomes inactive. */
152930
152994
  ends_at?: (string | null) | undefined
152931
- /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes). */
152995
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/low-level-apis/smart-locks/access-codes/lifecycle-of-access-codes).
152996
+ * @deprecated Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.*/
152932
152997
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
152998
+ /** Human-readable label for where this access code sits in its lifecycle, for example `Active`, `Issuing`, or `Expired`. 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 `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`. */
152999
+ display_status: string
152933
153000
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
152934
153001
  is_backup_access_code_available: boolean
152935
153002
  /** Indicates whether the access code is a backup code. */