@seamapi/http 2.1.0 → 2.2.0

package/src/lib/seam/connect/resources/acs-access-group.ts

@@ -3,7 +3,17 @@
  * Do not edit this file.
  */
 
+/**
+ * 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.
+ *
+ * Some access control systems use [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
+ *
+ * To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
+ */
 export type AcsAccessGroup = {
+  /**
+   * @deprecated Use `external_type`.
+   */
   access_group_type:
     | 'pti_unit'
     | 'pti_access_level'
@@ -16,32 +26,79 @@ export type AcsAccessGroup = {
     | 'kisi_access_group'
     | 'akiles_member_group'
 
+  /**
+   * @deprecated Use `external_type_display_name`.
+   */
   access_group_type_display_name: string
 
+  /**
+   * `starts_at` and `ends_at` timestamps for the access group's access.
+   */
   access_schedule?:
     | {
+        /**
+         * Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+         */
         ends_at: string | null
+        /**
+         * Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+         */
         starts_at: string
       }
     | undefined
+  /**
+   * 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 connected account that contains the access group.
+   */
   connected_account_id: string
 
+  /**
+   * Date and time at which the access group was created.
+   */
   created_at: string
 
+  /**
+   * Display name for the access group.
+   */
   display_name: string
 
-  errors: Array<{
-    created_at: string
-
-    error_code: 'failed_to_create_on_acs_system'
-
-    message: string
-  }>
+  /**
+   * Errors associated with the `acs_access_group`.
+   */
+  errors: Array<
+    /**
+     * Indicates that the [access group](https://docs.seam.co/low-level-apis/access-systems/user-management/assigning-users-to-access-groups) was not created on the [access system](https://docs.seam.co/low-level-apis/access-systems). This is likely due to an internal unexpected error. Contact Seam [support](mailto:support@seam.co).
+     */
+    {
+      /**
+       * Date and time at which Seam created the error.
+       */
+      created_at: string
+
+      /**
+       * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
+       */
+      error_code: 'failed_to_create_on_acs_system'
+
+      /**
+       * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+       */
+      message: string
+    }
+  >
 
+  /**
+   * Brand-specific terminology for the access group type.
+   */
   external_type:
     | 'pti_unit'
     | 'pti_access_level'
@@ -54,116 +111,292 @@ export type AcsAccessGroup = {
     | 'kisi_access_group'
     | 'akiles_member_group'
 
+  /**
+   * Display name that corresponds to the brand-specific terminology for the access group type.
+   */
   external_type_display_name: string
 
+  /**
+   * Indicates whether Seam manages the access group.
+   */
   is_managed: boolean
 
+  /**
+   * Name of the access group.
+   */
   name: string
 
+  /**
+   * Collection of pending mutations for the access group. Represents operations that have been requested but not yet completed on the integrated access system.
+   */
   pending_mutations: Array<
+    /**
+     * Seam is in the process of pushing an access group creation to the integrated access system.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of pushing an access group creation to the integrated access system.
+         */
         mutation_code: 'creating'
-      }
+      } /**
+     * Seam is in the process of pushing an access group deletion to the integrated access system.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of pushing an access group deletion to the integrated access system.
+         */
         mutation_code: 'deleting'
-      }
+      } /**
+     * This access group is scheduled for automatic deletion when its access window expires.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that this access group is scheduled for automatic deletion when its access window expires.
+         */
         mutation_code: 'deferring_deletion'
-      }
+      } /**
+     * Seam is in the process of pushing an access group information update to the integrated access system.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Old access group information.
+         */
         from: {
+          /**
+           * Name of the access group.
+           */
           name?: string | null | undefined
         }
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of pushing updated access group information to the integrated access system.
+         */
         mutation_code: 'updating_group_information'
 
+        /**
+         * New access group information.
+         */
         to: {
+          /**
+           * Name of the access group.
+           */
           name?: string | null | undefined
         }
-      }
+      } /**
+     * Seam is in the process of pushing an access schedule update to the integrated access system.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Old access schedule information.
+         */
         from: {
+          /**
+           * Ending time for the access schedule.
+           */
           ends_at: string | null
+          /**
+           * Starting time for the access schedule.
+           */
           starts_at: string | null
         }
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of pushing updated access schedule information to the integrated access system.
+         */
         mutation_code: 'updating_access_schedule'
 
+        /**
+         * New access schedule information.
+         */
         to: {
+          /**
+           * Ending time for the access schedule.
+           */
           ends_at: string | null
+          /**
+           * Starting time for the access schedule.
+           */
           starts_at: string | null
         }
-      }
+      } /**
+     * Seam is in the process of pushing a user membership update to the integrated access system.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Old user membership.
+         */
         from: {
+          /**
+           * Old user ID.
+           */
           acs_user_id: string | null
         }
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of pushing updated user membership information to the integrated access system.
+         */
         mutation_code: 'updating_user_membership'
 
+        /**
+         * New user membership.
+         */
         to: {
+          /**
+           * New user ID.
+           */
           acs_user_id: string | null
         }
-      }
+      } /**
+     * Seam is in the process of pushing an entrance membership update to the integrated access system.
+     */
     | {
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Old entrance membership.
+         */
         from: {
+          /**
+           * Old entrance ID.
+           */
           acs_entrance_id: string | null
         }
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that Seam is in the process of pushing updated entrance membership information to the integrated access system.
+         */
         mutation_code: 'updating_entrance_membership'
 
+        /**
+         * New entrance membership.
+         */
         to: {
+          /**
+           * New entrance ID.
+           */
           acs_entrance_id: string | null
         }
-      }
+      } /**
+     * A scheduled user membership change is pending for this access group.
+     */
     | {
+        /**
+         * ID of the user involved in the scheduled change.
+         */
         acs_user_id: string
 
+        /**
+         * Date and time at which the mutation was created.
+         */
         created_at: string
 
+        /**
+         * Detailed description of the mutation.
+         */
         message: string
 
+        /**
+         * Mutation code to indicate that a scheduled user membership change is pending for this access group.
+         */
         mutation_code: 'deferring_user_membership_update'
 
+        /**
+         * Whether the user is scheduled to be added to or removed from this access group.
+         */
         variant: 'adding' | 'removing'
       }
   >
 
+  /**
+   * Warnings associated with the `acs_access_group`.
+   */
   warnings: Array<{
+    /**
+     * 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: 'unknown_issue_with_acs_access_group' | 'being_deleted'
   }>
 
+  /**
+   * ID of the workspace that contains the access group.
+   */
   workspace_id: string
 }