@seamapi/types 1.272.0 → 1.274.0

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

@@ -3712,7 +3712,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired access group. */
       acs_access_group_id: string
+      /** ID of the desired user. */
       acs_user_id: string
     }
     formData: {}
@@ -3724,14 +3726,24 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired access group. */
       acs_access_group_id: string
     }
     formData: {}
     jsonResponse: {
+      /**
+        Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+        
+        The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+       */
       acs_access_group: {
+        /** ID of the access group. */
         acs_access_group_id: string
+        /** ID of the access control system that contains the access group. */
         acs_system_id: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
         workspace_id: string
+        /** Name of the access group. */
         name: string
         /**
          * @deprecated use external_type */
@@ -3744,12 +3756,15 @@ export interface Routes {
          * @deprecated use external_type_display_name */
         access_group_type_display_name: string
         display_name: string
+        /** Brand-specific terminology for the access group type. */
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
           | 'salto_access_group'
           | 'brivo_group'
+        /** Display name that corresponds to the brand-specific terminology for the access group type. */
         external_type_display_name: string
+        /** Date and time at which the access group was created. */
         created_at: string
         is_managed: true
       }
@@ -3761,15 +3776,21 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the access control system for which you want to retrieve all access groups. */
       acs_system_id?: string | undefined
+      /** ID of the user for which you want to retrieve all access groups. */
       acs_user_id?: string | undefined
     }
     formData: {}
     jsonResponse: {
       acs_access_groups: Array<{
+        /** ID of the access group. */
         acs_access_group_id: string
+        /** ID of the access control system that contains the access group. */
         acs_system_id: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
         workspace_id: string
+        /** Name of the access group. */
         name: string
         /**
          * @deprecated use external_type */
@@ -3782,12 +3803,15 @@ export interface Routes {
          * @deprecated use external_type_display_name */
         access_group_type_display_name: string
         display_name: string
+        /** Brand-specific terminology for the access group type. */
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
           | 'salto_access_group'
           | 'brivo_group'
+        /** Display name that corresponds to the brand-specific terminology for the access group type. */
         external_type_display_name: string
+        /** Date and time at which the access group was created. */
         created_at: string
         is_managed: true
       }>
@@ -3799,6 +3823,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the access group for which you want to retrieve all accessible entrances. */
       acs_access_group_id: string
     }
     formData: {}
@@ -3862,6 +3887,7 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the access group for which you want to retrieve all users. */
       acs_access_group_id: string
     }
     formData: {}
@@ -3981,7 +4007,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired access group. */
       acs_access_group_id: string
+      /** ID of the desired user. */
       acs_user_id: string
     }
     formData: {}
@@ -3993,14 +4021,19 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the desired unmanaged access group. */
       acs_access_group_id: string
     }
     formData: {}
     jsonResponse: {
       acs_access_group: {
+        /** ID of the access group. */
         acs_access_group_id: string
+        /** ID of the access control system that contains the access group. */
         acs_system_id: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
         workspace_id: string
+        /** Name of the access group. */
         name: string
         /**
          * @deprecated use external_type */
@@ -4013,12 +4046,15 @@ export interface Routes {
          * @deprecated use external_type_display_name */
         access_group_type_display_name: string
         display_name: string
+        /** Brand-specific terminology for the access group type. */
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
           | 'salto_access_group'
           | 'brivo_group'
+        /** Display name that corresponds to the brand-specific terminology for the access group type. */
         external_type_display_name: string
+        /** Date and time at which the access group was created. */
         created_at: string
         is_managed: false
       }
@@ -4030,15 +4066,21 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the access control system for which you want to retrieve all unmanaged access groups. */
       acs_system_id?: string | undefined
+      /** ID of the user for which you want to retrieve all unmanaged access groups. */
       acs_user_id?: string | undefined
     }
     formData: {}
     jsonResponse: {
       acs_access_groups: Array<{
+        /** ID of the access group. */
         acs_access_group_id: string
+        /** ID of the access control system that contains the access group. */
         acs_system_id: string
+        /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
         workspace_id: string
+        /** Name of the access group. */
         name: string
         /**
          * @deprecated use external_type */
@@ -4051,12 +4093,15 @@ export interface Routes {
          * @deprecated use external_type_display_name */
         access_group_type_display_name: string
         display_name: string
+        /** Brand-specific terminology for the access group type. */
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
           | 'salto_access_group'
           | 'brivo_group'
+        /** Display name that corresponds to the brand-specific terminology for the access group type. */
         external_type_display_name: string
+        /** Date and time at which the access group was created. */
         created_at: string
         is_managed: false
       }>
@@ -5724,6 +5769,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -5734,6 +5783,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -10532,6 +10591,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -10542,6 +10605,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -11318,6 +11391,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -11328,6 +11405,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -12805,6 +12892,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -12815,6 +12906,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -13420,6 +13521,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -13430,6 +13535,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -14206,6 +14321,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -14216,6 +14335,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -14821,6 +14950,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -14831,6 +14964,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -17165,6 +17308,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -17175,6 +17322,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -17780,6 +17937,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -17790,6 +17951,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -22522,6 +22693,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -22532,6 +22707,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -24838,6 +25023,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -24848,6 +25037,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -25453,6 +25652,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -25463,6 +25666,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -27926,6 +28139,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -27936,6 +28153,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string
@@ -28543,6 +28770,10 @@ export interface Routes {
                 model_number: string
               }
             | undefined
+          /**
+                ---
+                deprecated: Use `salto_ks_metadata ` instead.
+                 */
           salto_metadata?:
             | {
                 lock_id: string
@@ -28553,6 +28784,16 @@ export interface Routes {
                 model?: string | undefined
               }
             | undefined
+          salto_ks_metadata?:
+            | {
+                lock_id: string
+                customer_reference: string
+                lock_type: string
+                battery_level: string
+                locked_state: string
+                model?: string | undefined
+              }
+            | undefined
           genie_metadata?:
             | {
                 device_name: string