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

/**
 * Represents a [connected account](https://docs.seam.co/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks.
 */
export type ConnectedAccount = {
  /**
   * List of capabilities that were accepted during the account connection process.
   */
  accepted_capabilities: Array<
    'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera'
  >

  /**
   * Type of connected account.
   */
  account_type?: string | undefined
  /**
   * Display name for the connected account type.
   */
  account_type_display_name: string

  /**
   * Indicates whether Seam should [import all new devices](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for management by the Seam API.
   */
  automatically_manage_new_devices: boolean

  /**
   * ID of the connected account.
   */
  connected_account_id: string

  /**
   * Date and time at which the connected account was created.
   */
  created_at?: string | undefined
  /**
   * Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
   */
  custom_metadata: Record<string, unknown>

  /**
   * Your unique key for the customer associated with this connected account.
   */
  customer_key?: string | undefined
  /**
   * Default reservation check-in time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration — set during the connect_webview for providers like Lodgify whose API does not expose check-in times.
   */
  default_checkin_time?: string | undefined
  /**
   * Default reservation check-out time for this connected account, as `HH:mm` (24-hour). Sourced from the connector configuration.
   */
  default_checkout_time?: string | undefined
  /**
   * Display name for the connected account.
   */
  display_name: string

  /**
   * Errors associated with the connected account.
   */
  errors: Array<
    /**
     * Indicates that the account is disconnected.
     */
    | {
        /**
         * Date and time at which Seam created the error.
         */
        created_at: string

        /**
         * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         */
        error_code: 'account_disconnected'

        /**
         * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
         */
        is_bridge_error?: boolean | undefined
        /**
         * Indicates whether the error is related specifically to the connected account.
         */
        is_connected_account_error?: boolean | undefined
        /**
         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         */
        message: string
      } /**
     * Indicates that the Seam API cannot communicate with [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://docs.seam.co/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
     */
    | {
        /**
         * Date and time at which Seam created the error.
         */
        created_at: string

        /**
         * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         */
        error_code: 'bridge_disconnected'

        /**
         * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
         */
        is_bridge_error?: boolean | undefined
        /**
         * Indicates whether the error is related specifically to the connected account.
         */
        is_connected_account_error?: boolean | undefined
        /**
         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         */
        message: string
      } /**
     * Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit.
     */
    | {
        /**
         * Date and time at which Seam created the error.
         */
        created_at: string

        /**
         * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         */
        error_code: 'salto_ks_subscription_limit_exceeded'

        /**
         * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
         */
        is_bridge_error?: boolean | undefined
        /**
         * Indicates whether the error is related specifically to the connected account.
         */
        is_connected_account_error?: boolean | undefined
        /**
         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         */
        message: string

        /**
         * Salto KS metadata associated with the connected account that has an error.
         */
        salto_ks_metadata: {
          /**
           * Salto sites associated with the connected account that has an error.
           */
          sites?:
            | Array<{
                /**
                 * ID of a Salto site associated with the connected account that has an error.
                 */
                site_id?: string | undefined
                /**
                 * Name of a Salto site associated with the connected account that has an error.
                 */
                site_name?: string | undefined
                /**
                 * Subscription limit of site users for a Salto site associated with the connected account that has an error.
                 */
                site_user_subscription_limit?: number | undefined
                /**
                 * Count of subscribed site users for a Salto site associated with the connected account that has an error.
                 */
                subscribed_site_user_count?: number | undefined
              }>
            | undefined
        }
      } /**
     * Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.
     */
    | {
        /**
         * Date and time at which Seam created the error.
         */
        created_at: string

        /**
         * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
         */
        error_code: 'dormakaba_sites_disconnected'

        /**
         * Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/capability-guides/seam-bridge).
         */
        is_bridge_error?: boolean | undefined
        /**
         * Indicates whether the error is related specifically to the connected account.
         */
        is_connected_account_error?: boolean | undefined
        /**
         * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
         */
        message: string
      }
  >

  /**
   * For iCal connected accounts, the platform that produced the feed (for example, `airbnb`, `vrbo`, or `booking`), or `unknown` when it could not be determined. Intended for rendering the source platform's logo.
   */
  ical_feed_origin?: string | undefined
  /**
   * For iCal connected accounts, the feed URL for the connection. Sourced from the connector configuration.
   */
  ical_url?: string | undefined
  /**
   * Logo URL for the connected account provider.
   */
  image_url?: string | undefined
  /**
   * IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.
   */
  time_zone?: string | undefined
  /**
   * User identifier associated with the connected account.
   * @deprecated Use `display_name` instead.
   */
  user_identifier?:
    | {
        /**
         * API URL for the user identifier associated with the connected account.
         */
        api_url?: string | undefined
        /**
         * Email address of the user identifier associated with the connected account.
         */
        email?: string | undefined
        /**
         * Indicates whether the user identifier associated with the connected account is exclusive.
         */
        exclusive?: boolean | undefined
        /**
         * Phone number of the user identifier associated with the connected account.
         */
        phone?: string | undefined
        /**
         * Username of the user identifier associated with the connected account.
         */
        username?: string | undefined
      }
    | undefined
  /**
   * Warnings associated with the connected account.
   */
  warnings: Array<
    /**
     * Indicates that scheduled downtime is planned for the connected account.
     */
    | {
        /**
         * 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: 'scheduled_maintenance_window'
      } /**
     * Indicates that an unknown issue occurred while syncing the state of the connected account with the provider. This issue may affect the proper functioning of one or more resources in the account.
     */
    | {
        /**
         * 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_connected_account'
      } /**
     * Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
     */
    | {
        /**
         * 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

        /**
         * Salto KS metadata associated with the connected account that has a warning.
         */
        salto_ks_metadata: {
          /**
           * Salto sites associated with the connected account that has a warning.
           */
          sites?:
            | Array<{
                /**
                 * ID of a Salto site associated with the connected account that has a warning.
                 */
                site_id?: string | undefined
                /**
                 * Name of a Salto site associated with the connected account that has a warning.
                 */
                site_name?: string | undefined
                /**
                 * Subscription limit of site users for a Salto site associated with the connected account that has a warning.
                 */
                site_user_subscription_limit?: number | undefined
                /**
                 * Count of subscribed site users for a Salto site associated with the connected account that has a warning.
                 */
                subscribed_site_user_count?: number | undefined
              }>
            | undefined
        }

        /**
         * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
         */
        warning_code: 'salto_ks_subscription_limit_almost_reached'
      } /**
     * Indicates that the Connected Account requires reauthorization using a new Connect Webview. The account is still connected, but cannot access new features. Delaying reauthorization too long will eventually cause the Connected Account to become disconnected.
     */
    | {
        /**
         * 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: 'account_reauthorization_requested'
      } /**
     * Indicates that the connected account is currently being deleted. All devices, access codes, and other resources associated with this account are in the process of being removed from Seam.
     */
    | {
        /**
         * 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'
      } /**
     * Indicates that the connected account's provider service is temporarily unavailable. Seam will automatically retry and reconnect when the service becomes available again.
     */
    | {
        /**
         * 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: 'provider_service_unavailable'
      } /**
     * Indicates that the connected account requires additional setup before it can be fully operational. Follow the instructions in the warning message to complete the setup.
     */
    | {
        /**
         * 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: 'setup_required'
      } /**
     * Indicates that one or more dormakaba sites associated with the connected account are not approved. Contact support@getseam.com to finish setting up your account.
     */
    | {
        /**
         * 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: 'dormakaba_sites_unapproved'
      }
  >
}