@seamapi/types 1.827.0 → 1.829.0

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

@@ -12581,6 +12581,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** ID of the customization profile associated with the Access Grant. */
         customization_profile_id?: string | undefined
@@ -12807,6 +12809,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** ID of the customization profile associated with the Access Grant. */
         customization_profile_id?: string | undefined
@@ -14775,6 +14779,25 @@ export type Routes = {
                     site_name: string
                   }
                 | undefined
+              /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              avigilon_alta_metadata?:
+                | {
+                    /** Entry name for an Avigilon Alta system. */
+                    entry_name: string
+                    /** Organization name for an Avigilon Alta system. */
+                    org_name: string
+                    /** Zone ID for an Avigilon Alta system. */
+                    zone_id: number
+                    /** Zone name for an Avigilon Alta system. */
+                    zone_name: string
+                    /** Site ID for an Avigilon Alta system. */
+                    site_id: number
+                    /** Site name for an Avigilon Alta system. */
+                    site_name: string
+                    /** Total count of entry relays for an Avigilon Alta system. */
+                    entry_relays_total_count: number
+                  }
+                | undefined
               /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
               can_unlock_with_mobile_key?: boolean | undefined
               /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -14959,7 +14982,7 @@ export type Routes = {
               external_type?:
                 | (
                     | 'pti_site'
-                    | 'alta_org'
+                    | 'avigilon_alta_org'
                     | 'salto_ks_site'
                     | 'salto_space_system'
                     | 'brivo_account'
@@ -14994,7 +15017,7 @@ export type Routes = {
               system_type?:
                 | (
                     | 'pti_site'
-                    | 'alta_org'
+                    | 'avigilon_alta_org'
                     | 'salto_ks_site'
                     | 'salto_space_system'
                     | 'brivo_account'
@@ -15662,6 +15685,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** ID of the customization profile associated with the Access Grant. */
         customization_profile_id?: string | undefined
@@ -15888,6 +15913,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** ID of the customization profile associated with the Access Grant. */
         customization_profile_id?: string | undefined
@@ -16088,6 +16115,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** List of pending mutations for the access grant. This shows updates that are in progress. */
         pending_mutations: (
@@ -16297,6 +16326,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** List of pending mutations for the access grant. This shows updates that are in progress. */
         pending_mutations: (
@@ -20013,6 +20044,25 @@ export type Routes = {
                     site_name: string
                   }
                 | undefined
+              /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              avigilon_alta_metadata?:
+                | {
+                    /** Entry name for an Avigilon Alta system. */
+                    entry_name: string
+                    /** Organization name for an Avigilon Alta system. */
+                    org_name: string
+                    /** Zone ID for an Avigilon Alta system. */
+                    zone_id: number
+                    /** Zone name for an Avigilon Alta system. */
+                    zone_name: string
+                    /** Site ID for an Avigilon Alta system. */
+                    site_id: number
+                    /** Site name for an Avigilon Alta system. */
+                    site_name: string
+                    /** Total count of entry relays for an Avigilon Alta system. */
+                    entry_relays_total_count: number
+                  }
+                | undefined
               /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
               can_unlock_with_mobile_key?: boolean | undefined
               /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -20168,6 +20218,8 @@ export type Routes = {
                 message: string
                 /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                 error_code: 'cannot_create_requested_access_methods'
+                /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+                missing_device_ids?: string[] | undefined
               }[]
               /** ID of the customization profile associated with the Access Grant. */
               customization_profile_id?: string | undefined
@@ -21579,6 +21631,25 @@ export type Routes = {
               site_name: string
             }
           | undefined
+        /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        avigilon_alta_metadata?:
+          | {
+              /** Entry name for an Avigilon Alta system. */
+              entry_name: string
+              /** Organization name for an Avigilon Alta system. */
+              org_name: string
+              /** Zone ID for an Avigilon Alta system. */
+              zone_id: number
+              /** Zone name for an Avigilon Alta system. */
+              zone_name: string
+              /** Site ID for an Avigilon Alta system. */
+              site_id: number
+              /** Site name for an Avigilon Alta system. */
+              site_name: string
+              /** Total count of entry relays for an Avigilon Alta system. */
+              entry_relays_total_count: number
+            }
+          | undefined
         /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
         can_unlock_with_mobile_key?: boolean | undefined
         /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -23535,6 +23606,25 @@ export type Routes = {
               site_name: string
             }
           | undefined
+        /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        avigilon_alta_metadata?:
+          | {
+              /** Entry name for an Avigilon Alta system. */
+              entry_name: string
+              /** Organization name for an Avigilon Alta system. */
+              org_name: string
+              /** Zone ID for an Avigilon Alta system. */
+              zone_id: number
+              /** Zone name for an Avigilon Alta system. */
+              zone_name: string
+              /** Site ID for an Avigilon Alta system. */
+              site_id: number
+              /** Site name for an Avigilon Alta system. */
+              site_name: string
+              /** Total count of entry relays for an Avigilon Alta system. */
+              entry_relays_total_count: number
+            }
+          | undefined
         /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
         can_unlock_with_mobile_key?: boolean | undefined
         /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -27746,6 +27836,25 @@ export type Routes = {
               site_name: string
             }
           | undefined
+        /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        avigilon_alta_metadata?:
+          | {
+              /** Entry name for an Avigilon Alta system. */
+              entry_name: string
+              /** Organization name for an Avigilon Alta system. */
+              org_name: string
+              /** Zone ID for an Avigilon Alta system. */
+              zone_id: number
+              /** Zone name for an Avigilon Alta system. */
+              zone_name: string
+              /** Site ID for an Avigilon Alta system. */
+              site_id: number
+              /** Site name for an Avigilon Alta system. */
+              site_name: string
+              /** Total count of entry relays for an Avigilon Alta system. */
+              entry_relays_total_count: number
+            }
+          | undefined
         /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
         can_unlock_with_mobile_key?: boolean | undefined
         /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -27956,6 +28065,25 @@ export type Routes = {
               site_name: string
             }
           | undefined
+        /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        avigilon_alta_metadata?:
+          | {
+              /** Entry name for an Avigilon Alta system. */
+              entry_name: string
+              /** Organization name for an Avigilon Alta system. */
+              org_name: string
+              /** Zone ID for an Avigilon Alta system. */
+              zone_id: number
+              /** Zone name for an Avigilon Alta system. */
+              zone_name: string
+              /** Site ID for an Avigilon Alta system. */
+              site_id: number
+              /** Site name for an Avigilon Alta system. */
+              site_name: string
+              /** Total count of entry relays for an Avigilon Alta system. */
+              entry_relays_total_count: number
+            }
+          | undefined
         /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
         can_unlock_with_mobile_key?: boolean | undefined
         /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -29731,7 +29859,7 @@ export type Routes = {
         external_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -29766,7 +29894,7 @@ export type Routes = {
         system_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -29916,7 +30044,7 @@ export type Routes = {
         external_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -29951,7 +30079,7 @@ export type Routes = {
         system_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -30097,7 +30225,7 @@ export type Routes = {
         external_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -30132,7 +30260,7 @@ export type Routes = {
         system_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -31409,6 +31537,25 @@ export type Routes = {
               site_name: string
             }
           | undefined
+        /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        avigilon_alta_metadata?:
+          | {
+              /** Entry name for an Avigilon Alta system. */
+              entry_name: string
+              /** Organization name for an Avigilon Alta system. */
+              org_name: string
+              /** Zone ID for an Avigilon Alta system. */
+              zone_id: number
+              /** Zone name for an Avigilon Alta system. */
+              zone_name: string
+              /** Site ID for an Avigilon Alta system. */
+              site_id: number
+              /** Site name for an Avigilon Alta system. */
+              site_name: string
+              /** Total count of entry relays for an Avigilon Alta system. */
+              entry_relays_total_count: number
+            }
+          | undefined
         /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
         can_unlock_with_mobile_key?: boolean | undefined
         /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -44416,6 +44563,8 @@ export type Routes = {
                 event_type: 'access_grant.could_not_create_requested_access_methods'
                 /** Description of why the access methods could not be created. */
                 error_message: string
+                /** IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant. */
+                missing_device_ids?: string[] | undefined
               }
             | {
                 /** ID of the event. */
@@ -47834,6 +47983,8 @@ export type Routes = {
             event_type: 'access_grant.could_not_create_requested_access_methods'
             /** Description of why the access methods could not be created. */
             error_message: string
+            /** IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant. */
+            missing_device_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -73994,6 +74145,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** ID of the customization profile associated with the Access Grant. */
         customization_profile_id?: string | undefined
@@ -77703,6 +77856,8 @@ export type Routes = {
             event_type: 'access_grant.could_not_create_requested_access_methods'
             /** Description of why the access methods could not be created. */
             error_message: string
+            /** IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant. */
+            missing_device_ids?: string[] | undefined
           }
         | {
             /** ID of the event. */
@@ -80601,6 +80756,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** ID of the customization profile associated with the Access Grant. */
         customization_profile_id?: string | undefined
@@ -81114,6 +81271,8 @@ export type Routes = {
           message: string
           /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
           error_code: 'cannot_create_requested_access_methods'
+          /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+          missing_device_ids?: string[] | undefined
         }[]
         /** ID of the customization profile associated with the Access Grant. */
         customization_profile_id?: string | undefined
@@ -81848,6 +82007,25 @@ export type Routes = {
                     site_name: string
                   }
                 | undefined
+              /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              avigilon_alta_metadata?:
+                | {
+                    /** Entry name for an Avigilon Alta system. */
+                    entry_name: string
+                    /** Organization name for an Avigilon Alta system. */
+                    org_name: string
+                    /** Zone ID for an Avigilon Alta system. */
+                    zone_id: number
+                    /** Zone name for an Avigilon Alta system. */
+                    zone_name: string
+                    /** Site ID for an Avigilon Alta system. */
+                    site_id: number
+                    /** Site name for an Avigilon Alta system. */
+                    site_name: string
+                    /** Total count of entry relays for an Avigilon Alta system. */
+                    entry_relays_total_count: number
+                  }
+                | undefined
               /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
               can_unlock_with_mobile_key?: boolean | undefined
               /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -84062,6 +84240,25 @@ export type Routes = {
                     site_name: string
                   }
                 | undefined
+              /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              avigilon_alta_metadata?:
+                | {
+                    /** Entry name for an Avigilon Alta system. */
+                    entry_name: string
+                    /** Organization name for an Avigilon Alta system. */
+                    org_name: string
+                    /** Zone ID for an Avigilon Alta system. */
+                    zone_id: number
+                    /** Zone name for an Avigilon Alta system. */
+                    zone_name: string
+                    /** Site ID for an Avigilon Alta system. */
+                    site_id: number
+                    /** Site name for an Avigilon Alta system. */
+                    site_name: string
+                    /** Total count of entry relays for an Avigilon Alta system. */
+                    entry_relays_total_count: number
+                  }
+                | undefined
               /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
               can_unlock_with_mobile_key?: boolean | undefined
               /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -84246,7 +84443,7 @@ export type Routes = {
               external_type?:
                 | (
                     | 'pti_site'
-                    | 'alta_org'
+                    | 'avigilon_alta_org'
                     | 'salto_ks_site'
                     | 'salto_space_system'
                     | 'brivo_account'
@@ -84281,7 +84478,7 @@ export type Routes = {
               system_type?:
                 | (
                     | 'pti_site'
-                    | 'alta_org'
+                    | 'avigilon_alta_org'
                     | 'salto_ks_site'
                     | 'salto_space_system'
                     | 'brivo_account'
@@ -108376,6 +108573,25 @@ export type Routes = {
               site_name: string
             }
           | undefined
+        /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+        avigilon_alta_metadata?:
+          | {
+              /** Entry name for an Avigilon Alta system. */
+              entry_name: string
+              /** Organization name for an Avigilon Alta system. */
+              org_name: string
+              /** Zone ID for an Avigilon Alta system. */
+              zone_id: number
+              /** Zone name for an Avigilon Alta system. */
+              zone_name: string
+              /** Site ID for an Avigilon Alta system. */
+              site_id: number
+              /** Site name for an Avigilon Alta system. */
+              site_name: string
+              /** Total count of entry relays for an Avigilon Alta system. */
+              entry_relays_total_count: number
+            }
+          | undefined
         /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
         can_unlock_with_mobile_key?: boolean | undefined
         /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -108412,7 +108628,7 @@ export type Routes = {
         external_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -108447,7 +108663,7 @@ export type Routes = {
         system_type?:
           | (
               | 'pti_site'
-              | 'alta_org'
+              | 'avigilon_alta_org'
               | 'salto_ks_site'
               | 'salto_space_system'
               | 'brivo_account'
@@ -111319,6 +111535,25 @@ export type Routes = {
                     site_name: string
                   }
                 | undefined
+              /** Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
+              avigilon_alta_metadata?:
+                | {
+                    /** Entry name for an Avigilon Alta system. */
+                    entry_name: string
+                    /** Organization name for an Avigilon Alta system. */
+                    org_name: string
+                    /** Zone ID for an Avigilon Alta system. */
+                    zone_id: number
+                    /** Zone name for an Avigilon Alta system. */
+                    zone_name: string
+                    /** Site ID for an Avigilon Alta system. */
+                    site_id: number
+                    /** Site name for an Avigilon Alta system. */
+                    site_name: string
+                    /** Total count of entry relays for an Avigilon Alta system. */
+                    entry_relays_total_count: number
+                  }
+                | undefined
               /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
               can_unlock_with_mobile_key?: boolean | undefined
               /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -111345,7 +111580,7 @@ export type Routes = {
               external_type?:
                 | (
                     | 'pti_site'
-                    | 'alta_org'
+                    | 'avigilon_alta_org'
                     | 'salto_ks_site'
                     | 'salto_space_system'
                     | 'brivo_account'
@@ -111380,7 +111615,7 @@ export type Routes = {
               system_type?:
                 | (
                     | 'pti_site'
-                    | 'alta_org'
+                    | 'avigilon_alta_org'
                     | 'salto_ks_site'
                     | 'salto_space_system'
                     | 'brivo_account'
@@ -114960,6 +115195,8 @@ export type Routes = {
                 message: string
                 /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                 error_code: 'cannot_create_requested_access_methods'
+                /** IDs of the devices that did not receive an access code at grant creation. Use these to identify which specific devices failed when the message reports a partial failure. */
+                missing_device_ids?: string[] | undefined
               }[]
               /** ID of the customization profile associated with the Access Grant. */
               customization_profile_id?: string | undefined
@@ -116044,6 +116281,8 @@ export type Routes = {
                   event_type: 'access_grant.could_not_create_requested_access_methods'
                   /** Description of why the access methods could not be created. */
                   error_message: string
+                  /** IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant. */
+                  missing_device_ids?: string[] | undefined
                 }
               | {
                   /** ID of the event. */