@seamapi/types 1.272.0 → 1.273.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
       }>