/*
 * Automatically generated by codegen/smith.ts.
 * Do not edit this file.
 */

/**
 * Represents an app user's mobile phone.
 */
export type Phone = {
  /**
   * Date and time at which the phone was created.
   */
  created_at: string

  /**
   * Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
   */
  custom_metadata: Record<string, unknown>

  /**
   * ID of the phone.
   */
  device_id: string

  /**
   * Type of the phone device, such as `ios_phone` or `android_phone`.
   */
  device_type: 'ios_phone' | 'android_phone'

  /**
   * 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.
   */
  display_name: string

  /**
   * Errors associated with the phone.
   */
  errors: Array<{
    /**
     * Date and time at which Seam created the error.
     */
    created_at: string

    /**
     * Unique identifier of the type of error.
     */
    error_code: string

    /**
     * Detailed description of the error.
     */
    message: string
  }>

  /**
   * Optional nickname to describe the phone, settable through Seam.
   */
  nickname?: string | undefined
  /**
   * Properties of the phone.
   */
  properties: {
    /**
     * ASSA ABLOY Credential Service metadata for the phone.
     */
    assa_abloy_credential_service_metadata?:
      | {
          /**
           * Endpoints associated with the phone.
           */
          endpoints?:
            | Array<{
                /**
                 * ID of the associated endpoint.
                 */
                endpoint_id?: string | undefined
                /**
                 * Indicated whether the endpoint is active.
                 */
                is_active?: boolean | undefined
              }>
            | undefined
          /**
           * Indicates whether the credential service has active endpoints associated with the phone.
           */
          has_active_endpoint?: boolean | undefined
        }
      | undefined
    /**
     * Salto Space credential service metadata for the phone.
     */
    salto_space_credential_service_metadata?:
      | {
          /**
           * Indicates whether the credential service has an active associated phone.
           */
          has_active_phone?: boolean | undefined
        }
      | undefined
  }

  /**
   * Warnings associated with the phone.
   */
  warnings: Array<{
    /**
     * Date and time at which Seam created the warning.
     */
    created_at: string

    /**
     * Detailed description of the warning.
     */
    message: string

    /**
     * Unique identifier of the type of warning.
     */
    warning_code: string
  }>

  /**
   * ID of the workspace that contains the phone.
   */
  workspace_id: string
}