@seamapi/types 1.1055.0 → 1.1057.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.
@@ -2215,8 +2215,11 @@ export type Routes = {
2215
2215
  starts_at?: (string | null) | undefined;
2216
2216
  /** Date and time after which the time-bound access code becomes inactive. */
2217
2217
  ends_at?: (string | null) | undefined;
2218
- /** 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). */
2218
+ /** 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).
2219
+ * @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`.*/
2219
2220
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
2221
+ /** 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`. */
2222
+ display_status: string;
2220
2223
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
2221
2224
  is_backup_access_code_available: boolean;
2222
2225
  /** Indicates whether the access code is a backup code. */
@@ -2746,8 +2749,11 @@ export type Routes = {
2746
2749
  starts_at?: (string | null) | undefined;
2747
2750
  /** Date and time after which the time-bound access code becomes inactive. */
2748
2751
  ends_at?: (string | null) | undefined;
2749
- /** 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). */
2752
+ /** 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).
2753
+ * @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`.*/
2750
2754
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
2755
+ /** 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`. */
2756
+ display_status: string;
2751
2757
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
2752
2758
  is_backup_access_code_available: boolean;
2753
2759
  /** Indicates whether the access code is a backup code. */
@@ -5081,8 +5087,11 @@ export type Routes = {
5081
5087
  starts_at?: (string | null) | undefined;
5082
5088
  /** Date and time after which the time-bound access code becomes inactive. */
5083
5089
  ends_at?: (string | null) | undefined;
5084
- /** 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). */
5090
+ /** 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).
5091
+ * @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`.*/
5085
5092
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
5093
+ /** 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`. */
5094
+ display_status: string;
5086
5095
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
5087
5096
  is_backup_access_code_available: boolean;
5088
5097
  /** Indicates whether the access code is a backup code. */
@@ -5660,8 +5669,11 @@ export type Routes = {
5660
5669
  starts_at?: (string | null) | undefined;
5661
5670
  /** Date and time after which the time-bound access code becomes inactive. */
5662
5671
  ends_at?: (string | null) | undefined;
5663
- /** 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). */
5672
+ /** 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).
5673
+ * @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`.*/
5664
5674
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
5675
+ /** 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`. */
5676
+ display_status: string;
5665
5677
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
5666
5678
  is_backup_access_code_available: boolean;
5667
5679
  /** Indicates whether the access code is a backup code. */
@@ -6182,8 +6194,11 @@ export type Routes = {
6182
6194
  starts_at?: (string | null) | undefined;
6183
6195
  /** Date and time after which the time-bound access code becomes inactive. */
6184
6196
  ends_at?: (string | null) | undefined;
6185
- /** 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). */
6197
+ /** 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).
6198
+ * @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`.*/
6186
6199
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
6200
+ /** 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`. */
6201
+ display_status: string;
6187
6202
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
6188
6203
  is_backup_access_code_available: boolean;
6189
6204
  /** Indicates whether the access code is a backup code. */
@@ -6681,8 +6696,11 @@ export type Routes = {
6681
6696
  starts_at?: (string | null) | undefined;
6682
6697
  /** Date and time after which the time-bound access code becomes inactive. */
6683
6698
  ends_at?: (string | null) | undefined;
6684
- /** 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). */
6699
+ /** 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).
6700
+ * @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`.*/
6685
6701
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
6702
+ /** 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`. */
6703
+ display_status: string;
6686
6704
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
6687
6705
  is_backup_access_code_available: boolean;
6688
6706
  /** Indicates whether the access code is a backup code. */
@@ -7213,8 +7231,11 @@ export type Routes = {
7213
7231
  starts_at?: (string | null) | undefined;
7214
7232
  /** Date and time after which the time-bound access code becomes inactive. */
7215
7233
  ends_at?: (string | null) | undefined;
7216
- /** 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. */
7234
+ /** 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.
7235
+ * @deprecated Use `display_status` to show a person the code's state.*/
7217
7236
  status: 'set' | 'unset';
7237
+ /** 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. */
7238
+ display_status: string;
7218
7239
  /** 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. */
7219
7240
  cannot_be_managed?: true | undefined;
7220
7241
  /** 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. */
@@ -9457,8 +9478,11 @@ export type Routes = {
9457
9478
  starts_at?: (string | null) | undefined;
9458
9479
  /** Date and time after which the time-bound access code becomes inactive. */
9459
9480
  ends_at?: (string | null) | undefined;
9460
- /** 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. */
9481
+ /** 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.
9482
+ * @deprecated Use `display_status` to show a person the code's state.*/
9461
9483
  status: 'set' | 'unset';
9484
+ /** 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. */
9485
+ display_status: string;
9462
9486
  /** 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. */
9463
9487
  cannot_be_managed?: true | undefined;
9464
9488
  /** 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. */
@@ -9875,8 +9899,11 @@ export type Routes = {
9875
9899
  starts_at?: (string | null) | undefined;
9876
9900
  /** Date and time after which the time-bound access code becomes inactive. */
9877
9901
  ends_at?: (string | null) | undefined;
9878
- /** 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. */
9902
+ /** 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.
9903
+ * @deprecated Use `display_status` to show a person the code's state.*/
9879
9904
  status: 'set' | 'unset';
9905
+ /** 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. */
9906
+ display_status: string;
9880
9907
  /** 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. */
9881
9908
  cannot_be_managed?: true | undefined;
9882
9909
  /** 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. */
@@ -44809,7 +44836,7 @@ export type Routes = {
44809
44836
  /** Array of device types for which you want to list devices. */
44810
44837
  device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
44811
44838
  /** Manufacturer for which you want to list devices. */
44812
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
44839
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
44813
44840
  /** Array of device IDs for which you want to list devices. */
44814
44841
  device_ids?: string[] | undefined;
44815
44842
  /** Numerical limit on the number of devices to return. */
@@ -47060,7 +47087,7 @@ export type Routes = {
47060
47087
  /** Array of device types for which you want to list devices. */
47061
47088
  device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
47062
47089
  /** Manufacturer for which you want to list devices. */
47063
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
47090
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
47064
47091
  /** Array of device IDs for which you want to list devices. */
47065
47092
  device_ids?: string[] | undefined;
47066
47093
  /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
@@ -59798,7 +59825,7 @@ export type Routes = {
59798
59825
  /** Device types of the locks that you want to list. */
59799
59826
  device_types?: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock')[] | undefined;
59800
59827
  /** Manufacturer of the locks that you want to list. */
59801
- manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'dormakaba_oracode_iho' | 'korelock' | 'lockly' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi' | 'yacan') | undefined;
59828
+ manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'korelock' | 'lockly' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi' | 'yacan') | undefined;
59802
59829
  };
59803
59830
  formData: {};
59804
59831
  jsonResponse: {
@@ -127495,8 +127522,11 @@ export type Routes = {
127495
127522
  starts_at?: (string | null) | undefined;
127496
127523
  /** Date and time after which the time-bound access code becomes inactive. */
127497
127524
  ends_at?: (string | null) | undefined;
127498
- /** 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. */
127525
+ /** 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.
127526
+ * @deprecated Use `display_status` to show a person the code's state.*/
127499
127527
  status: 'set' | 'unset';
127528
+ /** 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. */
127529
+ display_status: string;
127500
127530
  /** 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. */
127501
127531
  cannot_be_managed?: true | undefined;
127502
127532
  /** 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. */
@@ -127897,8 +127927,11 @@ export type Routes = {
127897
127927
  starts_at?: (string | null) | undefined;
127898
127928
  /** Date and time after which the time-bound access code becomes inactive. */
127899
127929
  ends_at?: (string | null) | undefined;
127900
- /** 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). */
127930
+ /** 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).
127931
+ * @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`.*/
127901
127932
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
127933
+ /** 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`. */
127934
+ display_status: string;
127902
127935
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
127903
127936
  is_backup_access_code_available: boolean;
127904
127937
  /** Indicates whether the access code is a backup code. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1055.0",
3
+ "version": "1.1057.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -568,10 +568,16 @@ export const access_code = z.object({
568
568
  .describe(
569
569
  'Date and time after which the time-bound access code becomes inactive.',
570
570
  ),
571
- status: z
572
- .enum(['setting', 'set', 'unset', 'removing', 'unknown'])
571
+ status: z.enum(['setting', 'set', 'unset', 'removing', 'unknown']).describe(`
572
+ ---
573
+ 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\`.
574
+ ---
575
+ 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).
576
+ `),
577
+ display_status: z
578
+ .string()
573
579
  .describe(
574
- '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).',
580
+ '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`.',
575
581
  ),
576
582
  is_backup_access_code_available: z
577
583
  .boolean()
@@ -24,10 +24,16 @@ export const unmanaged_access_code = access_code
24
24
  is_managed: z
25
25
  .literal(false)
26
26
  .describe('Indicates that Seam does not manage the access code.'),
27
- status: z
28
- .enum(['set', 'unset'])
27
+ status: z.enum(['set', 'unset']).describe(`
28
+ ---
29
+ deprecated: Use \`display_status\` to show a person the code's state.
30
+ ---
31
+ 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.
32
+ `),
33
+ display_status: z
34
+ .string()
29
35
  .describe(
30
- '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.',
36
+ "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.",
31
37
  ),
32
38
  cannot_be_managed: z
33
39
  .literal(true)
@@ -35,6 +35,11 @@ const openapi: OpenAPISpec = {
35
35
  format: 'uuid',
36
36
  type: 'string',
37
37
  },
38
+ display_status: {
39
+ description:
40
+ '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`.',
41
+ type: 'string',
42
+ },
38
43
  dormakaba_oracode_metadata: {
39
44
  description:
40
45
  'Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.',
@@ -1381,10 +1386,13 @@ const openapi: OpenAPISpec = {
1381
1386
  type: 'string',
1382
1387
  },
1383
1388
  status: {
1389
+ deprecated: true,
1384
1390
  description:
1385
1391
  '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).',
1386
1392
  enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
1387
1393
  type: 'string',
1394
+ 'x-deprecated':
1395
+ "Use `display_status` to show a person the code's state. To make decisions, read `pending_mutations`, `errors`, `warnings`, `starts_at`, and `ends_at`.",
1388
1396
  },
1389
1397
  type: {
1390
1398
  description:
@@ -1765,6 +1773,7 @@ const openapi: OpenAPISpec = {
1765
1773
  'warnings',
1766
1774
  'is_managed',
1767
1775
  'status',
1776
+ 'display_status',
1768
1777
  'is_backup_access_code_available',
1769
1778
  'is_external_modification_allowed',
1770
1779
  'is_one_time_use',
@@ -31480,6 +31489,11 @@ const openapi: OpenAPISpec = {
31480
31489
  format: 'uuid',
31481
31490
  type: 'string',
31482
31491
  },
31492
+ display_status: {
31493
+ description:
31494
+ "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.",
31495
+ type: 'string',
31496
+ },
31483
31497
  dormakaba_oracode_metadata: {
31484
31498
  description:
31485
31499
  'Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.',
@@ -32515,10 +32529,13 @@ const openapi: OpenAPISpec = {
32515
32529
  type: 'string',
32516
32530
  },
32517
32531
  status: {
32532
+ deprecated: true,
32518
32533
  description:
32519
32534
  '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.',
32520
32535
  enum: ['set', 'unset'],
32521
32536
  type: 'string',
32537
+ 'x-deprecated':
32538
+ "Use `display_status` to show a person the code's state.",
32522
32539
  },
32523
32540
  type: {
32524
32541
  description:
@@ -32898,6 +32915,7 @@ const openapi: OpenAPISpec = {
32898
32915
  'warnings',
32899
32916
  'is_managed',
32900
32917
  'status',
32918
+ 'display_status',
32901
32919
  ],
32902
32920
  type: 'object',
32903
32921
  'x-route-path': '/access_codes/unmanaged',
@@ -50542,12 +50560,12 @@ const openapi: OpenAPISpec = {
50542
50560
  'ttlock',
50543
50561
  'igloohome',
50544
50562
  'controlbyweb',
50545
- 'dormakaba_oracode',
50546
50563
  'tedee',
50547
50564
  'keyincode',
50548
50565
  'akiles',
50549
50566
  'aqara',
50550
50567
  'ecobee',
50568
+ 'dormakaba_oracode',
50551
50569
  'dormakaba_oracode_iho',
50552
50570
  'honeywell_resideo',
50553
50571
  'keynest',
@@ -52842,12 +52860,12 @@ const openapi: OpenAPISpec = {
52842
52860
  'ttlock',
52843
52861
  'igloohome',
52844
52862
  'controlbyweb',
52845
- 'dormakaba_oracode',
52846
52863
  'tedee',
52847
52864
  'keyincode',
52848
52865
  'akiles',
52849
52866
  'aqara',
52850
52867
  'ecobee',
52868
+ 'dormakaba_oracode',
52851
52869
  'dormakaba_oracode_iho',
52852
52870
  'honeywell_resideo',
52853
52871
  'keynest',
@@ -54270,11 +54288,11 @@ const openapi: OpenAPISpec = {
54270
54288
  'ttlock',
54271
54289
  'igloohome',
54272
54290
  'four_suites',
54273
- 'dormakaba_oracode',
54274
54291
  'tedee',
54275
54292
  'keyincode',
54276
54293
  'akiles',
54277
54294
  'aqara',
54295
+ 'dormakaba_oracode',
54278
54296
  'dormakaba_oracode_iho',
54279
54297
  'korelock',
54280
54298
  'lockly',
@@ -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. */
@@ -52754,12 +52781,12 @@ export type Routes = {
52754
52781
  | 'ttlock'
52755
52782
  | 'igloohome'
52756
52783
  | 'controlbyweb'
52757
- | 'dormakaba_oracode'
52758
52784
  | 'tedee'
52759
52785
  | 'keyincode'
52760
52786
  | 'akiles'
52761
52787
  | 'aqara'
52762
52788
  | 'ecobee'
52789
+ | 'dormakaba_oracode'
52763
52790
  | 'dormakaba_oracode_iho'
52764
52791
  | 'honeywell_resideo'
52765
52792
  | 'keynest'
@@ -57069,12 +57096,12 @@ export type Routes = {
57069
57096
  | 'ttlock'
57070
57097
  | 'igloohome'
57071
57098
  | 'controlbyweb'
57072
- | 'dormakaba_oracode'
57073
57099
  | 'tedee'
57074
57100
  | 'keyincode'
57075
57101
  | 'akiles'
57076
57102
  | 'aqara'
57077
57103
  | 'ecobee'
57104
+ | 'dormakaba_oracode'
57078
57105
  | 'dormakaba_oracode_iho'
57079
57106
  | 'honeywell_resideo'
57080
57107
  | 'keynest'
@@ -72231,11 +72258,11 @@ export type Routes = {
72231
72258
  | 'ttlock'
72232
72259
  | 'igloohome'
72233
72260
  | 'four_suites'
72234
- | 'dormakaba_oracode'
72235
72261
  | 'tedee'
72236
72262
  | 'keyincode'
72237
72263
  | 'akiles'
72238
72264
  | 'aqara'
72265
+ | 'dormakaba_oracode'
72239
72266
  | 'dormakaba_oracode_iho'
72240
72267
  | 'korelock'
72241
72268
  | 'lockly'
@@ -152513,8 +152540,11 @@ export type Routes = {
152513
152540
  starts_at?: (string | null) | undefined
152514
152541
  /** Date and time after which the time-bound access code becomes inactive. */
152515
152542
  ends_at?: (string | null) | undefined
152516
- /** 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.*/
152517
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
152518
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. */
152519
152549
  cannot_be_managed?: true | undefined
152520
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. */
@@ -152962,8 +152992,11 @@ export type Routes = {
152962
152992
  starts_at?: (string | null) | undefined
152963
152993
  /** Date and time after which the time-bound access code becomes inactive. */
152964
152994
  ends_at?: (string | null) | undefined
152965
- /** 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`.*/
152966
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
152967
153000
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
152968
153001
  is_backup_access_code_available: boolean
152969
153002
  /** Indicates whether the access code is a backup code. */