@seamapi/types 1.487.0 → 1.489.0

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

@@ -11343,6 +11343,7 @@ export type Routes = {
             | 'connected_accounts'
             | 'acs_systems'
             | 'user_identity'
+            | 'acs_access_groups'
           )[]
         | undefined
       exclude?:
@@ -11353,6 +11354,7 @@ export type Routes = {
             | 'connected_accounts'
             | 'acs_systems'
             | 'user_identity'
+            | 'acs_access_groups'
           )[]
         | undefined
     }
@@ -13411,6 +13413,55 @@ export type Routes = {
               )[]
             }[]
           | undefined
+        acs_access_groups?:
+          | {
+              /** 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
+              /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
+              connected_account_id: string
+              /** Name of the access group. */
+              name: string
+              /**
+               * @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'
+              /**
+               * @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_ks_access_group'
+                | 'brivo_group'
+                | 'salto_space_group'
+                | 'dormakaba_community_access_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
+              /** Warnings associated with the `acs_access_group`. */
+              warnings: {
+                /** 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'
+              }[]
+              is_managed: true
+            }[]
+          | undefined
       }
     }
   }
@@ -17258,6 +17309,324 @@ export type Routes = {
               display_name: string
             }[]
           | undefined
+        acs_credentials?:
+          | {
+              /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_credential_id: string
+              /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              acs_user_id?: string | undefined
+              /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              user_identity_id?: string | undefined
+              /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              connected_account_id: string
+              acs_credential_pool_id?: string | undefined
+              /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_system_id: string
+              /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              parent_acs_credential_id?: string | undefined
+              /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              display_name: string
+              /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              code?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              card_number?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
+              is_issued?: boolean | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
+              issued_at?: (string | undefined) | null
+              /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
+              access_method: 'code' | 'card' | 'mobile_key'
+              /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/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'
+                  )
+                | undefined
+              /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              external_type_display_name?: string | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
+              created_at: string
+              /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              workspace_id: string
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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/latest/capability-guides/access-systems/managing-credentials). */
+              errors: {
+                error_code: string
+                message: string
+              }[]
+              /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              warnings: (
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+              )[]
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/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 latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
+              is_latest_desired_state_synced_with_provider?:
+                | (boolean | null)
+                | undefined
+              /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
+              latest_desired_state_synced_with_provider_at?:
+                | (string | null)
+                | undefined
+              /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              visionline_metadata?:
+                | {
+                    /** Card function type in the Visionline access system. */
+                    card_function_type: 'guest' | 'staff'
+                    /** IDs of the credentials to which you want to join. */
+                    joiner_acs_credential_ids?: string[] | undefined
+                    /** Guest entrance IDs in the Visionline access system. */
+                    guest_acs_entrance_ids?: string[] | undefined
+                    /** Common entrance IDs in the Visionline access system. */
+                    common_acs_entrance_ids?: string[] | undefined
+                    /** Indicates whether the credential is valid. */
+                    is_valid?: boolean | undefined
+                    /** 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
+                    /** ID of the card in the Visionline access system. */
+                    card_id?: string | undefined
+                    /** ID of the credential in the Visionline access system. */
+                    credential_id?: string | undefined
+                  }
+                | undefined
+              /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/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
+                    /** IDs of the guest entrances to override in the Vostio access system. */
+                    override_guest_acs_entrance_ids?: 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
+                    /** Names of the doors to which to grant access in the Vostio access system. */
+                    door_names?: string[] | undefined
+                    /** Endpoint ID in the Vostio access system. */
+                    endpoint_id?: string | undefined
+                  }
+                | undefined
+              is_managed: true
+            }[]
+          | undefined
+        unmanaged_acs_credentials?:
+          | {
+              /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_credential_id: string
+              /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              acs_user_id?: string | undefined
+              /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              user_identity_id?: string | undefined
+              /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              connected_account_id: string
+              acs_credential_pool_id?: string | undefined
+              /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_system_id: string
+              /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              parent_acs_credential_id?: string | undefined
+              /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              display_name: string
+              /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              code?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              card_number?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
+              is_issued?: boolean | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
+              issued_at?: (string | undefined) | null
+              /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
+              access_method: 'code' | 'card' | 'mobile_key'
+              /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/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'
+                  )
+                | undefined
+              /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              external_type_display_name?: string | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
+              created_at: string
+              /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              workspace_id: string
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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/latest/capability-guides/access-systems/managing-credentials). */
+              errors: {
+                error_code: string
+                message: string
+              }[]
+              /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              warnings: (
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+              )[]
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/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 latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
+              is_latest_desired_state_synced_with_provider?:
+                | (boolean | null)
+                | undefined
+              /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
+              latest_desired_state_synced_with_provider_at?:
+                | (string | null)
+                | undefined
+              /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              visionline_metadata?:
+                | {
+                    /** Card function type in the Visionline access system. */
+                    card_function_type: 'guest' | 'staff'
+                    /** IDs of the credentials to which you want to join. */
+                    joiner_acs_credential_ids?: string[] | undefined
+                    /** Guest entrance IDs in the Visionline access system. */
+                    guest_acs_entrance_ids?: string[] | undefined
+                    /** Common entrance IDs in the Visionline access system. */
+                    common_acs_entrance_ids?: string[] | undefined
+                    /** Indicates whether the credential is valid. */
+                    is_valid?: boolean | undefined
+                    /** 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
+                    /** ID of the card in the Visionline access system. */
+                    card_id?: string | undefined
+                    /** ID of the credential in the Visionline access system. */
+                    credential_id?: string | undefined
+                  }
+                | undefined
+              /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/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
+                    /** IDs of the guest entrances to override in the Vostio access system. */
+                    override_guest_acs_entrance_ids?: 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
+                    /** Names of the doors to which to grant access in the Vostio access system. */
+                    door_names?: string[] | undefined
+                    /** Endpoint ID in the Vostio access system. */
+                    endpoint_id?: string | undefined
+                  }
+                | undefined
+              is_managed: false
+            }[]
+          | undefined
         action_attempts?:
           | (
               | {
@@ -94449,6 +94818,324 @@ export type Routes = {
               display_name: string
             }[]
           | undefined
+        acs_credentials?:
+          | {
+              /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_credential_id: string
+              /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              acs_user_id?: string | undefined
+              /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              user_identity_id?: string | undefined
+              /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              connected_account_id: string
+              acs_credential_pool_id?: string | undefined
+              /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_system_id: string
+              /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              parent_acs_credential_id?: string | undefined
+              /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              display_name: string
+              /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              code?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              card_number?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
+              is_issued?: boolean | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
+              issued_at?: (string | undefined) | null
+              /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
+              access_method: 'code' | 'card' | 'mobile_key'
+              /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/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'
+                  )
+                | undefined
+              /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              external_type_display_name?: string | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
+              created_at: string
+              /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              workspace_id: string
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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/latest/capability-guides/access-systems/managing-credentials). */
+              errors: {
+                error_code: string
+                message: string
+              }[]
+              /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              warnings: (
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+              )[]
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/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 latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
+              is_latest_desired_state_synced_with_provider?:
+                | (boolean | null)
+                | undefined
+              /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
+              latest_desired_state_synced_with_provider_at?:
+                | (string | null)
+                | undefined
+              /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              visionline_metadata?:
+                | {
+                    /** Card function type in the Visionline access system. */
+                    card_function_type: 'guest' | 'staff'
+                    /** IDs of the credentials to which you want to join. */
+                    joiner_acs_credential_ids?: string[] | undefined
+                    /** Guest entrance IDs in the Visionline access system. */
+                    guest_acs_entrance_ids?: string[] | undefined
+                    /** Common entrance IDs in the Visionline access system. */
+                    common_acs_entrance_ids?: string[] | undefined
+                    /** Indicates whether the credential is valid. */
+                    is_valid?: boolean | undefined
+                    /** 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
+                    /** ID of the card in the Visionline access system. */
+                    card_id?: string | undefined
+                    /** ID of the credential in the Visionline access system. */
+                    credential_id?: string | undefined
+                  }
+                | undefined
+              /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/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
+                    /** IDs of the guest entrances to override in the Vostio access system. */
+                    override_guest_acs_entrance_ids?: 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
+                    /** Names of the doors to which to grant access in the Vostio access system. */
+                    door_names?: string[] | undefined
+                    /** Endpoint ID in the Vostio access system. */
+                    endpoint_id?: string | undefined
+                  }
+                | undefined
+              is_managed: true
+            }[]
+          | undefined
+        unmanaged_acs_credentials?:
+          | {
+              /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_credential_id: string
+              /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              acs_user_id?: string | undefined
+              /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              user_identity_id?: string | undefined
+              /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
+              connected_account_id: string
+              acs_credential_pool_id?: string | undefined
+              /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              acs_system_id: string
+              /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              parent_acs_credential_id?: string | undefined
+              /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              display_name: string
+              /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              code?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              card_number?: (string | undefined) | null
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
+              is_issued?: boolean | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
+              issued_at?: (string | undefined) | null
+              /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
+              access_method: 'code' | 'card' | 'mobile_key'
+              /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/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'
+                  )
+                | undefined
+              /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
+              external_type_display_name?: string | undefined
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
+              created_at: string
+              /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              workspace_id: string
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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
+              /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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/latest/capability-guides/access-systems/managing-credentials). */
+              errors: {
+                error_code: string
+                message: string
+              }[]
+              /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              warnings: (
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+                | {
+                    /** 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'
+                  }
+              )[]
+              /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/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 latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
+              is_latest_desired_state_synced_with_provider?:
+                | (boolean | null)
+                | undefined
+              /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
+              latest_desired_state_synced_with_provider_at?:
+                | (string | null)
+                | undefined
+              /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
+              visionline_metadata?:
+                | {
+                    /** Card function type in the Visionline access system. */
+                    card_function_type: 'guest' | 'staff'
+                    /** IDs of the credentials to which you want to join. */
+                    joiner_acs_credential_ids?: string[] | undefined
+                    /** Guest entrance IDs in the Visionline access system. */
+                    guest_acs_entrance_ids?: string[] | undefined
+                    /** Common entrance IDs in the Visionline access system. */
+                    common_acs_entrance_ids?: string[] | undefined
+                    /** Indicates whether the credential is valid. */
+                    is_valid?: boolean | undefined
+                    /** 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
+                    /** ID of the card in the Visionline access system. */
+                    card_id?: string | undefined
+                    /** ID of the credential in the Visionline access system. */
+                    credential_id?: string | undefined
+                  }
+                | undefined
+              /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/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
+                    /** IDs of the guest entrances to override in the Vostio access system. */
+                    override_guest_acs_entrance_ids?: 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
+                    /** Names of the doors to which to grant access in the Vostio access system. */
+                    door_names?: string[] | undefined
+                    /** Endpoint ID in the Vostio access system. */
+                    endpoint_id?: string | undefined
+                  }
+                | undefined
+              is_managed: false
+            }[]
+          | undefined
         action_attempts?:
           | (
               | {