npm - @seamapi/types - Versions diffs - 1.1054.0 → 1.1056.0 - Mend

@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

package/lib/seam/connect/route-types.d.ts CHANGED Viewed

@@ -2215,8 +2215,11 @@ export type Routes = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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). */
+                /** 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).
+                 * @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`.*/
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** 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`. */
+                display_status: string;
                 /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
                 /** Indicates whether the access code is a backup code. */
@@ -2746,8 +2749,11 @@ export type Routes = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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). */
+                /** 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).
+                 * @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`.*/
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** 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`. */
+                display_status: string;
                 /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
                 /** Indicates whether the access code is a backup code. */
@@ -5081,8 +5087,11 @@ export type Routes = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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). */
+                /** 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).
+                 * @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`.*/
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** 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`. */
+                display_status: string;
                 /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
                 /** Indicates whether the access code is a backup code. */
@@ -5660,8 +5669,11 @@ export type Routes = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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). */
+                /** 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).
+                 * @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`.*/
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** 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`. */
+                display_status: string;
                 /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
                 /** Indicates whether the access code is a backup code. */
@@ -6182,8 +6194,11 @@ export type Routes = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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). */
+                /** 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).
+                 * @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`.*/
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** 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`. */
+                display_status: string;
                 /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
                 /** Indicates whether the access code is a backup code. */
@@ -6681,8 +6696,11 @@ export type Routes = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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). */
+                /** 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).
+                 * @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`.*/
                 status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                /** 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`. */
+                display_status: string;
                 /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                 is_backup_access_code_available: boolean;
                 /** Indicates whether the access code is a backup code. */
@@ -7213,8 +7231,11 @@ export type Routes = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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. */
+                /** 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.
+                 * @deprecated Use `display_status` to show a person the code's state.*/
                 status: 'set' | 'unset';
+                /** 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. */
+                display_status: string;
                 /** 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. */
                 cannot_be_managed?: true | undefined;
                 /** 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 = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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. */
+                /** 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.
+                 * @deprecated Use `display_status` to show a person the code's state.*/
                 status: 'set' | 'unset';
+                /** 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. */
+                display_status: string;
                 /** 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. */
                 cannot_be_managed?: true | undefined;
                 /** 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 = {
                 starts_at?: (string | null) | undefined;
                 /** Date and time after which the time-bound access code becomes inactive. */
                 ends_at?: (string | null) | undefined;
-                /** 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. */
+                /** 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.
+                 * @deprecated Use `display_status` to show a person the code's state.*/
                 status: 'set' | 'unset';
+                /** 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. */
+                display_status: string;
                 /** 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. */
                 cannot_be_managed?: true | undefined;
                 /** 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. */
@@ -12802,8 +12829,8 @@ export type Routes = {
                                 userLevel?: (number | undefined) | undefined;
                                 userLevelName?: (string | undefined) | undefined;
                                 userLevelType?: (string | undefined) | undefined;
-                                checkInTime?: (string | undefined) | undefined;
-                                checkOutTime?: (string | undefined) | undefined;
+                                userLevelCheckInTime?: (string | undefined) | undefined;
+                                userLevelCheckOutTime?: (string | undefined) | undefined;
                             }[] | undefined) | undefined;
                         } | undefined;
                         /** Metadata for a Wyze device. */
@@ -19886,8 +19913,8 @@ export type Routes = {
                                 userLevel?: (number | undefined) | undefined;
                                 userLevelName?: (string | undefined) | undefined;
                                 userLevelType?: (string | undefined) | undefined;
-                                checkInTime?: (string | undefined) | undefined;
-                                checkOutTime?: (string | undefined) | undefined;
+                                userLevelCheckInTime?: (string | undefined) | undefined;
+                                userLevelCheckOutTime?: (string | undefined) | undefined;
                             }[] | undefined) | undefined;
                         } | undefined;
                         /** Metadata for a Wyze device. */
@@ -43773,8 +43800,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -45336,8 +45363,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -57251,8 +57278,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -58764,8 +58791,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -60300,8 +60327,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -61812,8 +61839,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -70538,8 +70565,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -72050,8 +72077,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -89450,8 +89477,8 @@ export type Routes = {
                                 userLevel?: (number | undefined) | undefined;
                                 userLevelName?: (string | undefined) | undefined;
                                 userLevelType?: (string | undefined) | undefined;
-                                checkInTime?: (string | undefined) | undefined;
-                                checkOutTime?: (string | undefined) | undefined;
+                                userLevelCheckInTime?: (string | undefined) | undefined;
+                                userLevelCheckOutTime?: (string | undefined) | undefined;
                             }[] | undefined) | undefined;
                         } | undefined;
                         /** Metadata for a Wyze device. */
@@ -97375,8 +97402,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -102519,8 +102546,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -104031,8 +104058,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -113741,8 +113768,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -115255,8 +115282,8 @@ export type Routes = {
                             userLevel?: (number | undefined) | undefined;
                             userLevelName?: (string | undefined) | undefined;
                             userLevelType?: (string | undefined) | undefined;
-                            checkInTime?: (string | undefined) | undefined;
-                            checkOutTime?: (string | undefined) | undefined;
+                            userLevelCheckInTime?: (string | undefined) | undefined;
+                            userLevelCheckOutTime?: (string | undefined) | undefined;
                         }[] | undefined) | undefined;
                     } | undefined;
                     /** Metadata for a Wyze device. */
@@ -118106,8 +118133,8 @@ export type Routes = {
                                 userLevel?: (number | undefined) | undefined;
                                 userLevelName?: (string | undefined) | undefined;
                                 userLevelType?: (string | undefined) | undefined;
-                                checkInTime?: (string | undefined) | undefined;
-                                checkOutTime?: (string | undefined) | undefined;
+                                userLevelCheckInTime?: (string | undefined) | undefined;
+                                userLevelCheckOutTime?: (string | undefined) | undefined;
                             }[] | undefined) | undefined;
                         } | undefined;
                         /** Metadata for a Wyze device. */
@@ -127495,8 +127522,11 @@ export type Routes = {
                     starts_at?: (string | null) | undefined;
                     /** Date and time after which the time-bound access code becomes inactive. */
                     ends_at?: (string | null) | undefined;
-                    /** 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. */
+                    /** 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.
+                     * @deprecated Use `display_status` to show a person the code's state.*/
                     status: 'set' | 'unset';
+                    /** 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. */
+                    display_status: string;
                     /** 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. */
                     cannot_be_managed?: true | undefined;
                     /** 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 = {
                     starts_at?: (string | null) | undefined;
                     /** Date and time after which the time-bound access code becomes inactive. */
                     ends_at?: (string | null) | undefined;
-                    /** 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). */
+                    /** 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).
+                     * @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`.*/
                     status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
+                    /** 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`. */
+                    display_status: string;
                     /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
                     is_backup_access_code_available: boolean;
                     /** Indicates whether the access code is a backup code. */

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.1054.0",
+  "version": "1.1056.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts CHANGED Viewed

@@ -568,10 +568,16 @@ export const access_code = z.object({
     .describe(
       'Date and time after which the time-bound access code becomes inactive.',
     ),
-  status: z
-    .enum(['setting', 'set', 'unset', 'removing', 'unknown'])
+  status: z.enum(['setting', 'set', 'unset', 'removing', 'unknown']).describe(`
+      ---
+      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\`.
+      ---
+      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).
+      `),
+  display_status: z
+    .string()
     .describe(
-      '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).',
+      '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`.',
     ),
   is_backup_access_code_available: z
     .boolean()

package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts CHANGED Viewed

@@ -24,10 +24,16 @@ export const unmanaged_access_code = access_code
     is_managed: z
       .literal(false)
       .describe('Indicates that Seam does not manage the access code.'),
-    status: z
-      .enum(['set', 'unset'])
+    status: z.enum(['set', 'unset']).describe(`
+      ---
+      deprecated: Use \`display_status\` to show a person the code's state.
+      ---
+      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.
+      `),
+    display_status: z
+      .string()
       .describe(
-        '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.',
+        "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.",
       ),
     cannot_be_managed: z
       .literal(true)

package/src/lib/seam/connect/models/devices/device-metadata.ts CHANGED Viewed

@@ -804,8 +804,8 @@ export const device_metadata = z
                 userLevel: z.number().optional(),
                 userLevelName: z.string().optional(),
                 userLevelType: z.string().optional(),
-                checkInTime: z.string().optional(),
-                checkOutTime: z.string().optional(),
+                userLevelCheckInTime: z.string().optional(),
+                userLevelCheckOutTime: z.string().optional(),
               })
               .partial(),
           )

package/src/lib/seam/connect/openapi.ts CHANGED Viewed

@@ -35,6 +35,11 @@ const openapi: OpenAPISpec = {
             format: 'uuid',
             type: 'string',
           },
+          display_status: {
+            description:
+              '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`.',
+            type: 'string',
+          },
           dormakaba_oracode_metadata: {
             description:
               'Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.',
@@ -1381,10 +1386,13 @@ const openapi: OpenAPISpec = {
             type: 'string',
           },
           status: {
+            deprecated: true,
             description:
               '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).',
             enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
             type: 'string',
+            'x-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`.",
           },
           type: {
             description:
@@ -1765,6 +1773,7 @@ const openapi: OpenAPISpec = {
           'warnings',
           'is_managed',
           'status',
+          'display_status',
           'is_backup_access_code_available',
           'is_external_modification_allowed',
           'is_one_time_use',
@@ -14755,9 +14764,9 @@ const openapi: OpenAPISpec = {
                               "User levels for a dormakaba Oracode Homeowner's Portal device.",
                             items: {
                               properties: {
-                                checkInTime: { type: 'string' },
-                                checkOutTime: { type: 'string' },
                                 userLevel: { format: 'float', type: 'number' },
+                                userLevelCheckInTime: { type: 'string' },
+                                userLevelCheckOutTime: { type: 'string' },
                                 userLevelName: { type: 'string' },
                                 userLevelType: { type: 'string' },
                               },
@@ -31480,6 +31489,11 @@ const openapi: OpenAPISpec = {
             format: 'uuid',
             type: 'string',
           },
+          display_status: {
+            description:
+              "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.",
+            type: 'string',
+          },
           dormakaba_oracode_metadata: {
             description:
               '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 = {
             type: 'string',
           },
           status: {
+            deprecated: true,
             description:
               '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.',
             enum: ['set', 'unset'],
             type: 'string',
+            'x-deprecated':
+              "Use `display_status` to show a person the code's state.",
           },
           type: {
             description:
@@ -32898,6 +32915,7 @@ const openapi: OpenAPISpec = {
           'warnings',
           'is_managed',
           'status',
+          'display_status',
         ],
         type: 'object',
         'x-route-path': '/access_codes/unmanaged',