@seamapi/http 2.1.0 → 2.2.0

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

@@ -1,89 +1,322 @@
+/**
+ * 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' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group' | '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<{
+    /**
+     * 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' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group' | '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;
-    pending_mutations: Array<{
+    /**
+     * 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;
 };

package/lib/seam/connect/resources/acs-credential.d.ts

@@ -1,74 +1,280 @@
+/**
+ * Means by which an [access control system user](https://docs.seam.co/low-level-apis/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+ *
+ * An access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.
+ *
+ * For each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.
+ *
+ * For granting a person access to a space, [Access Grants](https://docs.seam.co/use-cases/granting-access) are the default and recommended approach. Use the lower-level ACS credential API directly only when you specifically need to manage individual credentials.
+ */
 export type AcsCredential = {
+    /**
+     * Access method for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`.
+     */
     access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
+    /**
+     * ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     acs_credential_id: string;
+    /**
+     * ID of the credential pool to which the credential belongs.
+     */
     acs_credential_pool_id?: string | undefined;
+    /**
+     * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     acs_system_id: string;
+    /**
+     * ID of the [ACS user](https://docs.seam.co/low-level-apis/access-systems/user-management) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
+     */
     acs_user_id?: string | undefined;
+    /**
+     * Vostio-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     assa_abloy_vostio_metadata?: {
+        /**
+         * Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
+         */
         auto_join?: boolean | undefined;
+        /**
+         * Names of the doors to which to grant access in the Vostio access system.
+         */
         door_names?: Array<string> | undefined;
+        /**
+         * Endpoint ID in the Vostio access system.
+         */
         endpoint_id?: string | undefined;
+        /**
+         * Key ID in the Vostio access system.
+         */
         key_id?: string | undefined;
+        /**
+         * Key issuing request ID in the Vostio access system.
+         */
         key_issuing_request_id?: string | undefined;
+        /**
+         * IDs of the guest entrances to override in the Vostio access system.
+         */
         override_guest_acs_entrance_ids?: Array<string> | undefined;
     } | undefined;
+    /**
+     * Number of the card associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     card_number?: string | null | undefined;
+    /**
+     * Access (PIN) code for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     code?: string | null | undefined;
+    /**
+     * ID of the [connected account](https://docs.seam.co/core-concepts/connected-accounts) to which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
+     */
     connected_account_id: string;
+    /**
+     * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was created.
+     */
     created_at: string;
+    /**
+     * Display name that corresponds to the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
+     */
     display_name: string;
+    /**
+     * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
+     */
     ends_at?: string | undefined;
+    /**
+     * Errors associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     errors: Array<{
+        /**
+         * Date and time at which Seam created the error.
+         */
         created_at: string;
         error_code: string;
         message: string;
     }>;
+    /**
+     * Brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.
+     */
     external_type?: 'pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | undefined;
+    /**
+     * Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) type.
+     */
     external_type_display_name?: string | undefined;
+    /**
+     * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been encoded onto a card.
+     */
     is_issued?: boolean | undefined;
+    /**
+     * Indicates whether the latest state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider.
+     */
     is_latest_desired_state_synced_with_provider?: boolean | null | undefined;
+    /**
+     * Indicates whether Seam manages the credential.
+     */
     is_managed: boolean;
+    /**
+     * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials).
+     */
     is_multi_phone_sync_credential?: boolean | undefined;
+    /**
+     * Indicates whether the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.
+     */
     is_one_time_use?: boolean | undefined;
+    /**
+     * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was encoded onto a card.
+     */
     issued_at?: string | null | undefined;
+    /**
+     * Date and time at which the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider.
+     */
     latest_desired_state_synced_with_provider_at?: string | null | undefined;
+    /**
+     * ID of the parent [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     parent_acs_credential_id?: string | undefined;
+    /**
+     * Date and time at which the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
     starts_at?: string | undefined;
+    /**
+     * ID of the [user identity](https://docs.seam.co/api/user_identities) to whom the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) belongs.
+     */
     user_identity_id?: string | undefined;
+    /**
+     * Visionline-specific metadata for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     visionline_metadata?: {
+        /**
+         * Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors.
+         */
         auto_join?: boolean | undefined;
+        /**
+         * Card function type in the Visionline access system.
+         */
         card_function_type?: 'guest' | 'staff' | undefined;
+        /**
+         * ID of the card in the Visionline access system.
+         */
         card_id?: string | undefined;
+        /**
+         * Common entrance IDs in the Visionline access system.
+         */
         common_acs_entrance_ids?: Array<string> | undefined;
+        /**
+         * ID of the credential in the Visionline access system.
+         */
         credential_id?: string | undefined;
+        /**
+         * Guest entrance IDs in the Visionline access system.
+         */
         guest_acs_entrance_ids?: Array<string> | undefined;
+        /**
+         * Indicates whether the credential is valid.
+         */
         is_valid?: boolean | undefined;
+        /**
+         * IDs of the credentials to which you want to join.
+         */
         joiner_acs_credential_ids?: Array<string> | undefined;
     } | undefined;
-    warnings: Array<{
+    /**
+     * Warnings associated with the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
+    warnings: Array<
+    /**
+     * Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is waiting to be issued.
+     */
+    {
+        /**
+         * 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: 'waiting_to_be_issued';
-    } | {
+    } /**
+   * Indicates that the schedule of one of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials)'s children was modified externally.
+   */ | {
+        /**
+         * 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: 'schedule_externally_modified';
-    } | {
+    } /**
+   * Indicates that the schedule of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.
+   */ | {
+        /**
+         * 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: 'schedule_modified';
-    } | {
+    } /**
+   * Indicates that the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) is being deleted.
+   */ | {
+        /**
+         * 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: 'being_deleted';
-    } | {
+    } /**
+   * An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.
+   */ | {
+        /**
+         * 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_credential';
-    } | {
+    } /**
+   * Access permissions for the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.
+   */ | {
+        /**
+         * 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: 'needs_to_be_reissued';
     }>;
+    /**
+     * ID of the workspace that contains the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials).
+     */
     workspace_id: string;
 };

package/lib/seam/connect/resources/acs-encoder.d.ts

@@ -1,13 +1,59 @@
+/**
+ * Represents a hardware device that encodes [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/low-level-apis/access-systems).
+ *
+ * Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
+ *
+ * 1. Credential creation
+ *    Configure the access parameters for the credential.
+ * 2. Card encoding
+ *    Write the credential data onto the card using a compatible card encoder.
+ *
+ * Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
+ *
+ * See [Working with Card Encoders and Scanners](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+ *
+ * To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/device-and-system-integration-guides#access-control-systems).
+ */
 export type AcsEncoder = {
+    /**
+     * ID of the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     acs_encoder_id: string;
+    /**
+     * ID of the [access control system](https://docs.seam.co/low-level-apis/access-systems) that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     acs_system_id: string;
+    /**
+     * ID of the connected account that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     connected_account_id: string;
+    /**
+     * Date and time at which the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) was created.
+     */
     created_at: string;
+    /**
+     * Display name for the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     display_name: string;
+    /**
+     * Errors associated with the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     errors: Array<{
+        /**
+         * 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: 'acs_encoder_removed';
+        /**
+         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
+         */
         message: string;
     }>;
+    /**
+     * ID of the workspace that contains the [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
+     */
     workspace_id: string;
 };