@seamapi/http - v2.0.0
    Preparing search index...

    Type Alias Phone

    Represents an app user's mobile phone.

    type Phone = {
        created_at: string;
        custom_metadata: Record<string, unknown>;
        device_id: string;
        device_type: "ios_phone" | "android_phone";
        display_name: string;
        errors: { created_at: string; error_code: string; message: string }[];
        nickname?: string;
        properties: {
            assa_abloy_credential_service_metadata?: {
                endpoints?: { endpoint_id?: string; is_active?: boolean }[];
                has_active_endpoint?: boolean;
            };
            salto_space_credential_service_metadata?: { has_active_phone?: boolean };
        };
        warnings: { created_at: string; message: string; warning_code: string }[];
        workspace_id: string;
    }
    Index
    created_at custom_metadata device_id device_type display_name errors nickname? properties warnings workspace_id
    created_at: string

    Date and time at which the phone was created.

    custom_metadata: Record<string, unknown>

    Optional custom metadata for the phone.

    device_id: string

    ID of the phone.

    device_type: "ios_phone" | "android_phone"

    Type of the phone device, such as ios_phone or android_phone.

    display_name: string

    Display name of the phone. Defaults to nickname (if it is set) or properties.appearance.name, otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.

    errors: { created_at: string; error_code: string; message: string }[]

    Errors associated with the phone.

    Type Declaration

    • created_at: string

      Date and time at which Seam created the error.

    • error_code: string

      Unique identifier of the type of error.

    • message: string

      Detailed description of the error.

    nickname?: string

    Optional nickname to describe the phone, settable through Seam.

    properties: {
        assa_abloy_credential_service_metadata?: {
            endpoints?: { endpoint_id?: string; is_active?: boolean }[];
            has_active_endpoint?: boolean;
        };
        salto_space_credential_service_metadata?: { has_active_phone?: boolean };
    }

    Properties of the phone.

    Type Declaration

    • Optionalassa_abloy_credential_service_metadata?: {
          endpoints?: { endpoint_id?: string; is_active?: boolean }[];
          has_active_endpoint?: boolean;
      }

      ASSA ABLOY Credential Service metadata for the phone.

      • Optionalendpoints?: { endpoint_id?: string; is_active?: boolean }[]

        Endpoints associated with the phone.

      • Optionalhas_active_endpoint?: boolean

        Indicates whether the credential service has active endpoints associated with the phone.

    • Optionalsalto_space_credential_service_metadata?: { has_active_phone?: boolean }

      Salto Space credential service metadata for the phone.

      • Optionalhas_active_phone?: boolean

        Indicates whether the credential service has an active associated phone.

    warnings: { created_at: string; message: string; warning_code: string }[]

    Warnings associated with the phone.

    Type Declaration

    • created_at: string

      Date and time at which Seam created the warning.

    • message: string

      Detailed description of the warning.

    • warning_code: string

      Unique identifier of the type of warning.

    workspace_id: string

    ID of the workspace that contains the phone.

    Settings
    Member Visibility

    On This Page
    Properties