Type Alias UnmanagedAccessCode

Represents an unmanaged smart lock access code.

An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.

When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.

Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.

Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:

Kwikset

type UnmanagedAccessCode = {
    access_code_id: string;
    cannot_be_managed?: boolean;
    cannot_delete_unmanaged_access_code?: boolean;
    code: string | null;
    created_at: string;
    device_id: string;
    dormakaba_oracode_metadata?:
        | {
            is_cancellable?: boolean;
            is_early_checkin_able?: boolean;
            is_extendable?: boolean;
            is_overridable?: boolean;
            site_name?: string;
            stay_id?: number;
            user_level_id?: string;
            user_level_name?: string
            | null;
        }
        | null;
    ends_at?: string
    | null;
    errors: (
        | {
            created_at?: string;
            error_code: "provider_issue";
            is_access_code_error: boolean;
            message: string;
        }
        | {
            created_at?: string;
            error_code: "failed_to_set_on_device";
            is_access_code_error: boolean;
            message: string;
        }
        | {
            created_at?: string;
            error_code: "failed_to_remove_from_device";
            is_access_code_error: boolean;
            message: string;
        }
        | {
            created_at?: string;
            error_code: "duplicate_code_on_device";
            is_access_code_error: boolean;
            managed_access_code_id?: string;
            message: string;
            unmanaged_access_code_id?: string;
        }
        | {
            created_at?: string;
            error_code: "no_space_for_access_code_on_device";
            is_access_code_error: boolean;
            message: string;
        }
        | {
            change_type?: "modified"
            | "removed";
            created_at?: string;
            error_code: "conflicting_external_modification";
            is_access_code_error: boolean;
            message: string;
            modified_fields?: {
                field: string;
                from: string | null;
                to: string | null;
            }[];
        }
        | {
            created_at?: string;
            error_code: "access_code_inactive";
            is_access_code_error: boolean;
            message: string;
        }
        | {
            created_at?: string;
            error_code: "insufficient_permissions";
            is_access_code_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "account_disconnected";
            is_connected_account_error: boolean;
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "salto_ks_subscription_limit_exceeded";
            is_connected_account_error: boolean;
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "dormakaba_sites_disconnected";
            is_connected_account_error: boolean;
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "device_offline";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "device_removed";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "hub_disconnected";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "device_disconnected";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "empty_backup_access_code_pool";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "august_lock_not_authorized";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "missing_device_credentials";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "auxiliary_heat_running";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "subscription_required";
            is_device_error: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "bridge_disconnected";
            is_bridge_error?: boolean;
            is_connected_account_error?: boolean;
            message: string;
        }
    )[];
    is_managed: boolean;
    name: string
    | null;
    starts_at?: string | null;
    status: "set" | "unset";
    type: "time_bound" | "ongoing";
    warnings: (
        | {
            created_at?: string;
            message: string;
            warning_code: "code_rotates_periodically";
        }
        | {
            created_at?: string;
            message: string;
            warning_code: "time_frame_adjusted_for_unknown_time_zone";
        }
        | {
            change_type?: "modified"
            | "removed";
            created_at?: string;
            message: string;
            modified_fields?: {
                field: string;
                from: string | null;
                to: string | null;
            }[];
            warning_code: "external_modification_in_effect";
        }
        | {
            created_at?: string;
            message: string;
            warning_code: "delay_in_setting_on_device";
        }
        | {
            created_at?: string;
            message: string;
            warning_code: "delay_in_removing_from_device";
        }
        | {
            created_at?: string;
            message: string;
            warning_code: "third_party_integration_detected";
        }
        | {
            created_at?: string;
            message: string;
            warning_code: "igloo_algopin_must_be_used_within_24_hours";
        }
        | {
            created_at?: string;
            message: string;
            warning_code: "management_transferred";
        }
        | {
            created_at?: string;
            message: string;
            warning_code: "using_backup_access_code";
        }
        | { created_at?: string; message: string; warning_code: "being_deleted" }
        | {
            created_at?: string;
            message: string;
            warning_code: "unknown_issue_with_access_code";
        }
    )[];
    workspace_id: string;
}

Index

Properties

access_code_id cannot_be_managed? cannot_delete_unmanaged_access_code? code created_at device_id dormakaba_oracode_metadata? ends_at? errors is_managed name starts_at? status type warnings workspace_id

Properties

access_code_id

access_code_id: string

Unique identifier for the access code.

`Optional`cannot_be_managed

cannot_be_managed?: boolean

Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.

`Optional`cannot_delete_unmanaged_access_code

cannot_delete_unmanaged_access_code?: boolean

Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.

code

code: string | null

Code used for access. Typically, a numeric or alphanumeric string.

created_at

created_at: string

Date and time at which the access code was created.

device_id

device_id: string

Unique identifier for the device associated with the access code.

`Optional`dormakaba_oracode_metadata

dormakaba_oracode_metadata?:
    | {
        is_cancellable?: boolean;
        is_early_checkin_able?: boolean;
        is_extendable?: boolean;
        is_overridable?: boolean;
        site_name?: string;
        stay_id?: number;
        user_level_id?: string;
        user_level_name?: string
        | null;
    }
    | null

Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices.

Type Declaration

{
    is_cancellable?: boolean;
    is_early_checkin_able?: boolean;
    is_extendable?: boolean;
    is_overridable?: boolean;
    site_name?: string;
    stay_id?: number;
    user_level_id?: string;
    user_level_name?: string | null;
}
- Optionalis_cancellable?: boolean
  
  Indicates whether the stay can be cancelled via the Dormakaba Oracode API.
- Optionalis_early_checkin_able?: boolean
  
  Indicates whether early check-in is available for this stay.
- Optionalis_extendable?: boolean
  
  Indicates whether the stay can be extended via the Dormakaba Oracode API.
- Optionalis_overridable?: boolean
  
  Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached.
- Optionalsite_name?: string
  
  Dormakaba Oracode site name associated with this access code.
- Optionalstay_id?: number
  
  Dormakaba Oracode stay ID associated with this access code.
- Optionaluser_level_id?: string
  
  Dormakaba Oracode user level ID associated with this access code.
- Optionaluser_level_name?: string | null
  
  Dormakaba Oracode user level name associated with this access code.
null

`Optional`ends_at

ends_at?: string | null

Date and time after which the time-bound access code becomes inactive.

errors

errors: (
    | {
        created_at?: string;
        error_code: "provider_issue";
        is_access_code_error: boolean;
        message: string;
    }
    | {
        created_at?: string;
        error_code: "failed_to_set_on_device";
        is_access_code_error: boolean;
        message: string;
    }
    | {
        created_at?: string;
        error_code: "failed_to_remove_from_device";
        is_access_code_error: boolean;
        message: string;
    }
    | {
        created_at?: string;
        error_code: "duplicate_code_on_device";
        is_access_code_error: boolean;
        managed_access_code_id?: string;
        message: string;
        unmanaged_access_code_id?: string;
    }
    | {
        created_at?: string;
        error_code: "no_space_for_access_code_on_device";
        is_access_code_error: boolean;
        message: string;
    }
    | {
        change_type?: "modified"
        | "removed";
        created_at?: string;
        error_code: "conflicting_external_modification";
        is_access_code_error: boolean;
        message: string;
        modified_fields?: {
            field: string;
            from: string | null;
            to: string | null;
        }[];
    }
    | {
        created_at?: string;
        error_code: "access_code_inactive";
        is_access_code_error: boolean;
        message: string;
    }
    | {
        created_at?: string;
        error_code: "insufficient_permissions";
        is_access_code_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "account_disconnected";
        is_connected_account_error: boolean;
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "salto_ks_subscription_limit_exceeded";
        is_connected_account_error: boolean;
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "dormakaba_sites_disconnected";
        is_connected_account_error: boolean;
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "device_offline";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "device_removed";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "hub_disconnected";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "device_disconnected";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "empty_backup_access_code_pool";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "august_lock_not_authorized";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "missing_device_credentials";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "auxiliary_heat_running";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "subscription_required";
        is_device_error: boolean;
        message: string;
    }
    | {
        created_at: string;
        error_code: "bridge_disconnected";
        is_bridge_error?: boolean;
        is_connected_account_error?: boolean;
        message: string;
    }
)[]

Errors associated with the access code.

Type Declaration

{
    created_at?: string;
    error_code: "provider_issue";
    is_access_code_error: boolean;
    message: string;
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "provider_issue"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at?: string;
    error_code: "failed_to_set_on_device";
    is_access_code_error: boolean;
    message: string;
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "failed_to_set_on_device"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at?: string;
    error_code: "failed_to_remove_from_device";
    is_access_code_error: boolean;
    message: string;
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "failed_to_remove_from_device"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at?: string;
    error_code: "duplicate_code_on_device";
    is_access_code_error: boolean;
    managed_access_code_id?: string;
    message: string;
    unmanaged_access_code_id?: string;
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "duplicate_code_on_device"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- Optionalmanaged_access_code_id?: string
  
  ID of the managed access code that conflicts with this managed access code, when Seam can identify it.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
- Optionalunmanaged_access_code_id?: string
  
  ID of the unmanaged access code that conflicts with this managed access code, when Seam can identify it.
{
    created_at?: string;
    error_code: "no_space_for_access_code_on_device";
    is_access_code_error: boolean;
    message: string;
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "no_space_for_access_code_on_device"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    change_type?: "modified" | "removed";
    created_at?: string;
    error_code: "conflicting_external_modification";
    is_access_code_error: boolean;
    message: string;
    modified_fields?: { field: string; from: string | null; to: string | null }[];
}
- Optionalchange_type?: "modified" | "removed"
  
  Indicates the type of external modification. modified means the code's PIN or schedule was changed. removed means the code was deleted from the device.
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "conflicting_external_modification"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
- Optionalmodified_fields?: { field: string; from: string | null; to: string | null }[]
  
  List of fields that were changed externally, with their previous and new values.
{
    created_at?: string;
    error_code: "access_code_inactive";
    is_access_code_error: boolean;
    message: string;
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "access_code_inactive"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at?: string;
    error_code: "insufficient_permissions";
    is_access_code_error: boolean;
    message: string;
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the error.
- error_code: "insufficient_permissions"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_access_code_error: boolean
  
  Indicates that this is an access code error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "account_disconnected";
    is_connected_account_error: boolean;
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "account_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_connected_account_error: boolean
  
  Indicates that the error is a connected account error.
- is_device_error: boolean
  
  Indicates that the error is not a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "salto_ks_subscription_limit_exceeded";
    is_connected_account_error: boolean;
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "salto_ks_subscription_limit_exceeded"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_connected_account_error: boolean
  
  Indicates that the error is a connected account error.
- is_device_error: boolean
  
  Indicates that the error is not a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "dormakaba_sites_disconnected";
    is_connected_account_error: boolean;
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "dormakaba_sites_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_connected_account_error: boolean
  
  Indicates that the error is a connected account error.
- is_device_error: boolean
  
  Indicates that the error is not a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "device_offline";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "device_offline"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "device_removed";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "device_removed"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "hub_disconnected";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "hub_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "device_disconnected";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "device_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "empty_backup_access_code_pool";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "empty_backup_access_code_pool"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "august_lock_not_authorized";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "august_lock_not_authorized"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "missing_device_credentials";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "missing_device_credentials"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "auxiliary_heat_running";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "auxiliary_heat_running"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "subscription_required";
    is_device_error: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "subscription_required"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- is_device_error: boolean
  
  Indicates that the error is a device error.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
{
    created_at: string;
    error_code: "bridge_disconnected";
    is_bridge_error?: boolean;
    is_connected_account_error?: boolean;
    message: string;
}
- created_at: string
  
  Date and time at which Seam created the error.
- error_code: "bridge_disconnected"
  
  Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
- Optionalis_bridge_error?: boolean
  
  Indicates whether the error is related to Seam Bridge.
- Optionalis_connected_account_error?: boolean
  
  Indicates whether the error is related specifically to the connected account.
- message: string
  
  Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

is_managed

is_managed: boolean

Indicates that Seam does not manage the access code.

name

name: string | null

Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as first_name and last_name. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called appearance. This is an object with a name property and, optionally, first_name and last_name properties (for providers that break down a name into components).

`Optional`starts_at

starts_at?: string | null

Date and time at which the time-bound access code becomes active.

status

status: "set" | "unset"

Current status of the access code within the operational lifecycle. set indicates that the code is active and operational. unset indicates that the code exists on the provider but is not usable on the device.

type

type: "time_bound" | "ongoing"

Type of the access code. ongoing access codes are active continuously until deactivated manually. time_bound access codes have a specific duration.

warnings

warnings: (
    | {
        created_at?: string;
        message: string;
        warning_code: "code_rotates_periodically";
    }
    | {
        created_at?: string;
        message: string;
        warning_code: "time_frame_adjusted_for_unknown_time_zone";
    }
    | {
        change_type?: "modified"
        | "removed";
        created_at?: string;
        message: string;
        modified_fields?: {
            field: string;
            from: string | null;
            to: string | null;
        }[];
        warning_code: "external_modification_in_effect";
    }
    | {
        created_at?: string;
        message: string;
        warning_code: "delay_in_setting_on_device";
    }
    | {
        created_at?: string;
        message: string;
        warning_code: "delay_in_removing_from_device";
    }
    | {
        created_at?: string;
        message: string;
        warning_code: "third_party_integration_detected";
    }
    | {
        created_at?: string;
        message: string;
        warning_code: "igloo_algopin_must_be_used_within_24_hours";
    }
    | {
        created_at?: string;
        message: string;
        warning_code: "management_transferred";
    }
    | {
        created_at?: string;
        message: string;
        warning_code: "using_backup_access_code";
    }
    | { created_at?: string; message: string; warning_code: "being_deleted" }
    | {
        created_at?: string;
        message: string;
        warning_code: "unknown_issue_with_access_code";
    }
)[]

Warnings associated with the access code.

Type Declaration

{
    created_at?: string;
    message: string;
    warning_code: "code_rotates_periodically";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "code_rotates_periodically"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at?: string;
    message: string;
    warning_code: "time_frame_adjusted_for_unknown_time_zone";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "time_frame_adjusted_for_unknown_time_zone"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    change_type?: "modified" | "removed";
    created_at?: string;
    message: string;
    modified_fields?: { field: string; from: string | null; to: string | null }[];
    warning_code: "external_modification_in_effect";
}
- Optionalchange_type?: "modified" | "removed"
  
  Indicates the type of external modification. modified means the code's PIN or schedule was changed. removed means the code was deleted from the device.
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- Optionalmodified_fields?: { field: string; from: string | null; to: string | null }[]
  
  List of fields that were changed externally, with their previous and new values.
- warning_code: "external_modification_in_effect"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at?: string;
    message: string;
    warning_code: "delay_in_setting_on_device";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "delay_in_setting_on_device"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at?: string;
    message: string;
    warning_code: "delay_in_removing_from_device";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "delay_in_removing_from_device"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at?: string;
    message: string;
    warning_code: "third_party_integration_detected";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "third_party_integration_detected"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at?: string;
    message: string;
    warning_code: "igloo_algopin_must_be_used_within_24_hours";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "igloo_algopin_must_be_used_within_24_hours"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at?: string; message: string; warning_code: "management_transferred" }
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "management_transferred"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at?: string;
    message: string;
    warning_code: "using_backup_access_code";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "using_backup_access_code"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{ created_at?: string; message: string; warning_code: "being_deleted" }
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "being_deleted"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
{
    created_at?: string;
    message: string;
    warning_code: "unknown_issue_with_access_code";
}
- Optionalcreated_at?: string
  
  Date and time at which Seam created the warning.
- message: string
  
  Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
- warning_code: "unknown_issue_with_access_code"
  
  Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

workspace_id

workspace_id: string

Unique identifier for the Seam workspace associated with the access code.

Type Alias UnmanagedAccessCode

Index

Properties

Properties

access_code_id

Optionalcannot_be_managed

Optionalcannot_delete_unmanaged_access_code

code

created_at

device_id

Optionaldormakaba_oracode_metadata

Type Declaration

Optionalis_cancellable?: boolean

Optionalis_early_checkin_able?: boolean

Optionalis_extendable?: boolean

Optionalis_overridable?: boolean

Optionalsite_name?: string

Optionalstay_id?: number

Optionaluser_level_id?: string

Optionaluser_level_name?: string | null

Optionalends_at

errors

Type Declaration

Optionalcreated_at?: string

error_code: "provider_issue"

is_access_code_error: boolean

message: string

Optionalcreated_at?: string

error_code: "failed_to_set_on_device"

is_access_code_error: boolean

message: string

Optionalcreated_at?: string

error_code: "failed_to_remove_from_device"

is_access_code_error: boolean

message: string

Optionalcreated_at?: string

error_code: "duplicate_code_on_device"

is_access_code_error: boolean

Optionalmanaged_access_code_id?: string

message: string

Optionalunmanaged_access_code_id?: string

Optionalcreated_at?: string

error_code: "no_space_for_access_code_on_device"

is_access_code_error: boolean

message: string

Optionalchange_type?: "modified" | "removed"

Optionalcreated_at?: string

error_code: "conflicting_external_modification"

is_access_code_error: boolean

message: string

Optionalmodified_fields?: { field: string; from: string | null; to: string | null }[]

Optionalcreated_at?: string

error_code: "access_code_inactive"

is_access_code_error: boolean

message: string

Optionalcreated_at?: string

error_code: "insufficient_permissions"

is_access_code_error: boolean

message: string

created_at: string

error_code: "account_disconnected"

is_connected_account_error: boolean

is_device_error: boolean

message: string

created_at: string

error_code: "salto_ks_subscription_limit_exceeded"

is_connected_account_error: boolean

is_device_error: boolean

message: string

created_at: string

error_code: "dormakaba_sites_disconnected"

is_connected_account_error: boolean

is_device_error: boolean

message: string

created_at: string

error_code: "device_offline"

is_device_error: boolean

message: string

created_at: string

error_code: "device_removed"

`Optional`cannot_be_managed

`Optional`cannot_delete_unmanaged_access_code

`Optional`dormakaba_oracode_metadata

`Optional`is_cancellable?: boolean

`Optional`is_early_checkin_able?: boolean

`Optional`is_extendable?: boolean

`Optional`is_overridable?: boolean

`Optional`site_name?: string

`Optional`stay_id?: number

`Optional`user_level_id?: string

`Optional`user_level_name?: string | null

`Optional`ends_at

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`managed_access_code_id?: string

`Optional`unmanaged_access_code_id?: string

`Optional`created_at?: string

`Optional`change_type?: "modified" | "removed"

`Optional`created_at?: string

`Optional`modified_fields?: { field: string; from: string | null; to: string | null }[]

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`is_bridge_error?: boolean

`Optional`is_connected_account_error?: boolean

`Optional`starts_at

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`change_type?: "modified" | "removed"

`Optional`created_at?: string

`Optional`modified_fields?: { field: string; from: string | null; to: string | null }[]

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`created_at?: string

`Optional`created_at?: string