@seamapi/types 1.242.0 → 1.243.0

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

@@ -3184,14 +3184,21 @@ export interface Routes {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
-                    error_code: 'salto_site_user_limit_reached';
+                    error_code: 'salto_ks_subscription_limit_exceeded';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
-                    error_code: 'salto_seam_integration_blocked';
+                    /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
+                    error_code: 'acs_system_disconnected';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
+                    error_code: 'account_disconnected';
                 }>;
                 /** Warnings associated with the `acs_system`. */
                 warnings: Array<{
@@ -3199,8 +3206,8 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
-                    warning_code: 'salto_site_user_limit_almost_reached';
+                    /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
+                    warning_code: 'salto_ks_subscription_limit_almost_reached';
                 }>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
@@ -3275,14 +3282,21 @@ export interface Routes {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
-                    error_code: 'salto_site_user_limit_reached';
+                    error_code: 'salto_ks_subscription_limit_exceeded';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
-                    error_code: 'salto_seam_integration_blocked';
+                    /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
+                    error_code: 'acs_system_disconnected';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
+                    error_code: 'account_disconnected';
                 }>;
                 /** Warnings associated with the `acs_system`. */
                 warnings: Array<{
@@ -3290,8 +3304,8 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
-                    warning_code: 'salto_site_user_limit_almost_reached';
+                    /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
+                    warning_code: 'salto_ks_subscription_limit_almost_reached';
                 }>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
@@ -3366,14 +3380,21 @@ export interface Routes {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
-                    error_code: 'salto_site_user_limit_reached';
+                    error_code: 'salto_ks_subscription_limit_exceeded';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
-                    error_code: 'salto_seam_integration_blocked';
+                    /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
+                    error_code: 'acs_system_disconnected';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
+                    error_code: 'account_disconnected';
                 }>;
                 /** Warnings associated with the `acs_system`. */
                 warnings: Array<{
@@ -3381,8 +3402,8 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
-                    warning_code: 'salto_site_user_limit_almost_reached';
+                    /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
+                    warning_code: 'salto_ks_subscription_limit_almost_reached';
                 }>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;
@@ -5408,6 +5429,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -5544,7 +5577,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -5852,6 +5885,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -5988,7 +6033,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -6676,6 +6721,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -6812,7 +6869,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -7095,6 +7152,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -7231,7 +7300,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -7539,6 +7608,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -7675,7 +7756,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -7958,6 +8039,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -8094,7 +8187,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -9232,6 +9325,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -9368,7 +9473,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -9651,6 +9756,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -9787,7 +9904,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -12111,7 +12228,7 @@ export interface Routes {
         jsonBody: {
             device_id: string;
             climate_preset_key: string;
-            name: string | null;
+            name?: string | null;
             fan_mode_setting?: ('auto' | 'on') | undefined;
             hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
             cooling_set_point_celsius?: number | undefined;
@@ -12127,7 +12244,7 @@ export interface Routes {
                 climate_preset_key: string;
                 can_edit: boolean;
                 can_delete: boolean;
-                name: string | null;
+                name?: string | null;
                 display_name: string;
                 fan_mode_setting?: ('auto' | 'on') | undefined;
                 hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -12368,6 +12485,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -12504,7 +12633,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -13614,6 +13743,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -13750,7 +13891,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -14766,7 +14907,7 @@ export interface Routes {
         jsonBody: {
             device_id: string;
             climate_preset_key: string;
-            name: string | null;
+            name?: string | null;
             fan_mode_setting?: ('auto' | 'on') | undefined;
             hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
             cooling_set_point_celsius?: number | undefined;
@@ -14782,7 +14923,7 @@ export interface Routes {
                 climate_preset_key: string;
                 can_edit: boolean;
                 can_delete: boolean;
-                name: string | null;
+                name?: string | null;
                 display_name: string;
                 fan_mode_setting?: ('auto' | 'on') | undefined;
                 hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -15189,6 +15330,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -15325,7 +15478,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -15610,6 +15763,18 @@ export interface Routes {
                         lock_id: number;
                         lock_alias: string;
                         feature_value: string;
+                        features: {
+                            passcode: boolean;
+                            passcode_management: boolean;
+                            unlock_via_gateway: boolean;
+                            lock_command: boolean;
+                            incomplete_keyboard_passcode: boolean;
+                        };
+                        has_gateway?: boolean | undefined;
+                        wireless_keypads?: Array<{
+                            wireless_keypad_id: number;
+                            wireless_keypad_name: string;
+                        }> | undefined;
                     } | undefined;
                     seam_bridge_metadata?: {
                         unlock_method?: ('bridge' | 'doorking') | undefined;
@@ -15746,7 +15911,7 @@ export interface Routes {
                         climate_preset_key: string;
                         can_edit: boolean;
                         can_delete: boolean;
-                        name: string | null;
+                        name?: string | null;
                         display_name: string;
                         fan_mode_setting?: ('auto' | 'on') | undefined;
                         hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
@@ -15886,14 +16051,21 @@ export interface Routes {
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
                     /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
-                    error_code: 'salto_site_user_limit_reached';
+                    error_code: 'salto_ks_subscription_limit_exceeded';
+                } | {
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
+                    error_code: 'acs_system_disconnected';
                 } | {
                     /** Date and time at which Seam created the error. */
                     created_at: string;
                     /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** Indicates that the Seam Integration user site is blocked. This means that Seam does not have permission to access Salto resources. Go to Salto Dashboard to remove 'Seam Integration' block */
-                    error_code: 'salto_seam_integration_blocked';
+                    /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
+                    error_code: 'account_disconnected';
                 }>;
                 /** Warnings associated with the `acs_system`. */
                 warnings: Array<{
@@ -15901,8 +16073,8 @@ export interface Routes {
                     created_at: string;
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string;
-                    /** You have reached more than 80% of the maximum number of users allowed for your site; Please contact Salto support to increase your user limit. */
-                    warning_code: 'salto_site_user_limit_almost_reached';
+                    /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
+                    warning_code: 'salto_ks_subscription_limit_almost_reached';
                 }>;
                 /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
                 can_automate_enrollment?: boolean | undefined;