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

    Type Alias ConnectedAccount

    Represents a connected account. 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.

    type ConnectedAccount = {
        accepted_capabilities: (
            "lock"
            | "thermostat"
            | "noise_sensor"
            | "access_control"
            | "camera"
        )[];
        account_type?: string;
        account_type_display_name: string;
        automatically_manage_new_devices: boolean;
        connected_account_id: string;
        created_at?: string;
        custom_metadata: Record<string, unknown>;
        customer_key?: string;
        default_checkin_time?: string;
        default_checkout_time?: string;
        display_name: string;
        errors: (
            | {
                created_at: string;
                error_code: "account_disconnected";
                is_bridge_error?: boolean;
                is_connected_account_error?: boolean;
                message: string;
            }
            | {
                created_at: string;
                error_code: "bridge_disconnected";
                is_bridge_error?: boolean;
                is_connected_account_error?: boolean;
                message: string;
            }
            | {
                created_at: string;
                error_code: "salto_ks_subscription_limit_exceeded";
                is_bridge_error?: boolean;
                is_connected_account_error?: boolean;
                message: string;
                salto_ks_metadata: {
                    sites?: {
                        site_id?: string;
                        site_name?: string;
                        site_user_subscription_limit?: number;
                        subscribed_site_user_count?: number;
                    }[];
                };
            }
            | {
                created_at: string;
                error_code: "dormakaba_sites_disconnected";
                is_bridge_error?: boolean;
                is_connected_account_error?: boolean;
                message: string;
            }
        )[];
        ical_feed_origin?: string;
        ical_url?: string;
        image_url?: string;
        time_zone?: string;
        user_identifier?: {
            api_url?: string;
            email?: string;
            exclusive?: boolean;
            phone?: string;
            username?: string;
        };
        warnings: (
            | {
                created_at: string;
                message: string;
                warning_code: "scheduled_maintenance_window";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "unknown_issue_with_connected_account";
            }
            | {
                created_at: string;
                message: string;
                salto_ks_metadata: {
                    sites?: {
                        site_id?: string;
                        site_name?: string;
                        site_user_subscription_limit?: number;
                        subscribed_site_user_count?: number;
                    }[];
                };
                warning_code: "salto_ks_subscription_limit_almost_reached";
            }
            | {
                created_at: string;
                message: string;
                warning_code: "account_reauthorization_requested";
            }
            | { created_at: string; message: string; warning_code: "being_deleted" }
            | {
                created_at: string;
                message: string;
                warning_code: "provider_service_unavailable";
            }
            | { created_at: string; message: string; warning_code: "setup_required" }
            | {
                created_at: string;
                message: string;
                warning_code: "dormakaba_sites_unapproved";
            }
        )[];
    }
    Index
    accepted_capabilities account_type? account_type_display_name automatically_manage_new_devices connected_account_id created_at? custom_metadata customer_key? default_checkin_time? default_checkout_time? display_name errors ical_feed_origin? ical_url? image_url? time_zone? user_identifier? warnings
    accepted_capabilities: (
        "lock"
        | "thermostat"
        | "noise_sensor"
        | "access_control"
        | "camera"
    )[]

    List of capabilities that were accepted during the account connection process.

    account_type?: string

    Type of connected account.

    account_type_display_name: string

    Display name for the connected account type.

    automatically_manage_new_devices: boolean

    Indicates whether Seam should import all new devices for the connected account to make these devices available for management by the Seam API.

    connected_account_id: string

    ID of the connected account.

    created_at?: string

    Date and time at which the connected account was created.

    custom_metadata: Record<string, unknown>

    Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application.

    customer_key?: string

    Your unique key for the customer associated with this connected account.

    default_checkin_time?: string

    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_checkout_time?: string

    Default reservation check-out time for this connected account, as HH:mm (24-hour). Sourced from the connector configuration.

    display_name: string

    Display name for the connected account.

    errors: (
        | {
            created_at: string;
            error_code: "account_disconnected";
            is_bridge_error?: boolean;
            is_connected_account_error?: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "bridge_disconnected";
            is_bridge_error?: boolean;
            is_connected_account_error?: boolean;
            message: string;
        }
        | {
            created_at: string;
            error_code: "salto_ks_subscription_limit_exceeded";
            is_bridge_error?: boolean;
            is_connected_account_error?: boolean;
            message: string;
            salto_ks_metadata: {
                sites?: {
                    site_id?: string;
                    site_name?: string;
                    site_user_subscription_limit?: number;
                    subscribed_site_user_count?: number;
                }[];
            };
        }
        | {
            created_at: string;
            error_code: "dormakaba_sites_disconnected";
            is_bridge_error?: boolean;
            is_connected_account_error?: boolean;
            message: string;
        }
    )[]

    Errors associated with the connected account.

    Type Declaration

    • {
          created_at: string;
          error_code: "account_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: "account_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.

    • {
          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.

    • {
          created_at: string;
          error_code: "salto_ks_subscription_limit_exceeded";
          is_bridge_error?: boolean;
          is_connected_account_error?: boolean;
          message: string;
          salto_ks_metadata: {
              sites?: {
                  site_id?: string;
                  site_name?: string;
                  site_user_subscription_limit?: number;
                  subscribed_site_user_count?: number;
              }[];
          };
      }
      • 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.

      • 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.

      • salto_ks_metadata: {
            sites?: {
                site_id?: string;
                site_name?: string;
                site_user_subscription_limit?: number;
                subscribed_site_user_count?: number;
            }[];
        }

        Salto KS metadata associated with the connected account that has an error.

        • Optionalsites?: {
              site_id?: string;
              site_name?: string;
              site_user_subscription_limit?: number;
              subscribed_site_user_count?: number;
          }[]

          Salto sites associated with the connected account that has an error.

    • {
          created_at: string;
          error_code: "dormakaba_sites_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: "dormakaba_sites_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.

    ical_feed_origin?: 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_url?: string

    For iCal connected accounts, the feed URL for the connection. Sourced from the connector configuration.

    image_url?: string

    Logo URL for the connected account provider.

    time_zone?: string

    IANA time zone (e.g. America/Los_Angeles) for this connected account. Sourced from the connector configuration.

    user_identifier?: {
        api_url?: string;
        email?: string;
        exclusive?: boolean;
        phone?: string;
        username?: string;
    }

    User identifier associated with the connected account.

    Type Declaration

    • Optionalapi_url?: string

      API URL for the user identifier associated with the connected account.

    • Optionalemail?: string

      Email address of the user identifier associated with the connected account.

    • Optionalexclusive?: boolean

      Indicates whether the user identifier associated with the connected account is exclusive.

    • Optionalphone?: string

      Phone number of the user identifier associated with the connected account.

    • Optionalusername?: string

      Username of the user identifier associated with the connected account.

    Use display_name instead.

    warnings: (
        | {
            created_at: string;
            message: string;
            warning_code: "scheduled_maintenance_window";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "unknown_issue_with_connected_account";
        }
        | {
            created_at: string;
            message: string;
            salto_ks_metadata: {
                sites?: {
                    site_id?: string;
                    site_name?: string;
                    site_user_subscription_limit?: number;
                    subscribed_site_user_count?: number;
                }[];
            };
            warning_code: "salto_ks_subscription_limit_almost_reached";
        }
        | {
            created_at: string;
            message: string;
            warning_code: "account_reauthorization_requested";
        }
        | { created_at: string; message: string; warning_code: "being_deleted" }
        | {
            created_at: string;
            message: string;
            warning_code: "provider_service_unavailable";
        }
        | { created_at: string; message: string; warning_code: "setup_required" }
        | {
            created_at: string;
            message: string;
            warning_code: "dormakaba_sites_unapproved";
        }
    )[]

    Warnings associated with the connected account.

    Type Declaration

    • {
          created_at: string;
          message: string;
          warning_code: "scheduled_maintenance_window";
      }
      • created_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: "scheduled_maintenance_window"

        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_connected_account";
      }
      • created_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_connected_account"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    • {
          created_at: string;
          message: string;
          salto_ks_metadata: {
              sites?: {
                  site_id?: string;
                  site_name?: string;
                  site_user_subscription_limit?: number;
                  subscribed_site_user_count?: number;
              }[];
          };
          warning_code: "salto_ks_subscription_limit_almost_reached";
      }
      • created_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.

      • salto_ks_metadata: {
            sites?: {
                site_id?: string;
                site_name?: string;
                site_user_subscription_limit?: number;
                subscribed_site_user_count?: number;
            }[];
        }

        Salto KS metadata associated with the connected account that has a warning.

        • Optionalsites?: {
              site_id?: string;
              site_name?: string;
              site_user_subscription_limit?: number;
              subscribed_site_user_count?: number;
          }[]

          Salto sites associated with the connected account that has a warning.

      • warning_code: "salto_ks_subscription_limit_almost_reached"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    • {
          created_at: string;
          message: string;
          warning_code: "account_reauthorization_requested";
      }
      • created_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: "account_reauthorization_requested"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    • { created_at: string; message: string; warning_code: "being_deleted" }
      • created_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: "provider_service_unavailable";
      }
      • created_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: "provider_service_unavailable"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    • { created_at: string; message: string; warning_code: "setup_required" }
      • created_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: "setup_required"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    • {
          created_at: string;
          message: string;
          warning_code: "dormakaba_sites_unapproved";
      }
      • created_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: "dormakaba_sites_unapproved"

        Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

    Settings
    Member Visibility

    On This Page
    Properties