@seamapi/types 1.951.0 → 1.953.0

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

@@ -14900,6 +14900,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
                 | {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string
@@ -15160,6 +15168,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
               )[]
               /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
               latch_metadata?:
@@ -22826,6 +22842,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
                 | {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string
@@ -23086,6 +23110,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
               )[]
               /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
               latch_metadata?:
@@ -26695,6 +26727,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
         )[]
         /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
         latch_metadata?:
@@ -28768,6 +28808,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
         )[]
         /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
         latch_metadata?:
@@ -35832,6 +35880,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
         )[]
         /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
         latch_metadata?:
@@ -36098,6 +36154,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
         )[]
         /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
         latch_metadata?:
@@ -40150,6 +40214,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
         )[]
         /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
         latch_metadata?:
@@ -49097,6 +49169,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -51167,6 +51247,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -53296,6 +53384,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -54147,6 +54243,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -57603,6 +57707,21 @@ export type Routes = {
               ID of the ACS entrance associated with the access-denied event.
              */
                 acs_entrance_id?: string | undefined
+                /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+                reason?:
+                  | {
+                      /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                      reason_code:
+                        | 'unknown_code'
+                        | 'expired_code'
+                        | 'blocklisted_code'
+                        | 'too_many_attempts'
+                        | 'blocked_by_privacy_mode'
+                        | 'credential_error'
+                      /** Human-readable explanation of why access was denied. */
+                      message: string
+                    }
+                  | undefined
               }
             | {
                 /** ID of the event. */
@@ -61466,6 +61585,21 @@ export type Routes = {
               ID of the ACS entrance associated with the access-denied event.
              */
             acs_entrance_id?: string | undefined
+            /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+            reason?:
+              | {
+                  /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                  reason_code:
+                    | 'unknown_code'
+                    | 'expired_code'
+                    | 'blocklisted_code'
+                    | 'too_many_attempts'
+                    | 'blocked_by_privacy_mode'
+                    | 'credential_error'
+                  /** Human-readable explanation of why access was denied. */
+                  message: string
+                }
+              | undefined
           }
         | {
             /** ID of the event. */
@@ -65626,6 +65760,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -67452,6 +67594,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -69475,6 +69625,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -71300,6 +71458,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -81034,6 +81200,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -82859,6 +83033,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -96807,6 +96989,21 @@ export type Routes = {
               ID of the ACS entrance associated with the access-denied event.
              */
             acs_entrance_id?: string | undefined
+            /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+            reason?:
+              | {
+                  /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                  reason_code:
+                    | 'unknown_code'
+                    | 'expired_code'
+                    | 'blocklisted_code'
+                    | 'too_many_attempts'
+                    | 'blocked_by_privacy_mode'
+                    | 'credential_error'
+                  /** Human-readable explanation of why access was denied. */
+                  message: string
+                }
+              | undefined
           }
         | {
             /** ID of the event. */
@@ -99182,6 +99379,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
               )[]
               /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
               latch_metadata?:
@@ -101404,6 +101609,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
                 | {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string
@@ -101664,6 +101877,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
               )[]
               /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
               latch_metadata?:
@@ -110203,6 +110424,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -116072,6 +116301,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -117897,6 +118134,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -128566,6 +128811,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -130393,6 +130646,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
           | {
               /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
               message: string
@@ -130661,6 +130922,14 @@ export type Routes = {
               /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
               warning_code: 'salto_ks_privacy_mode'
             }
+          | {
+              /** Date and time at which Seam created the warning. */
+              created_at: string
+              /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+              message: string
+              /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+              warning_code: 'privacy_mode'
+            }
         )[]
         /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
         latch_metadata?:
@@ -133670,6 +133939,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
                 | {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string
@@ -133930,6 +134207,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
               )[]
               /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
               latch_metadata?:
@@ -137656,6 +137941,14 @@ export type Routes = {
                     /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
                     warning_code: 'salto_ks_privacy_mode'
                   }
+                | {
+                    /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
+                    message: string
+                    /** Date and time at which Seam created the warning. */
+                    created_at: string
+                    /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
+                    warning_code: 'privacy_mode'
+                  }
                 | {
                     /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
                     message: string
@@ -141664,6 +141957,21 @@ export type Routes = {
                   ID of the ACS entrance associated with the access-denied event.
                  */
                   acs_entrance_id?: string | undefined
+                  /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+                  reason?:
+                    | {
+                        /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                        reason_code:
+                          | 'unknown_code'
+                          | 'expired_code'
+                          | 'blocklisted_code'
+                          | 'too_many_attempts'
+                          | 'blocked_by_privacy_mode'
+                          | 'credential_error'
+                        /** Human-readable explanation of why access was denied. */
+                        message: string
+                      }
+                    | undefined
                 }
               | {
                   /** ID of the event. */