Constructors

Properties

client: AxiosInstance
defaults: Required<SeamHttpRequestOptions>

Methods

  • Parameters

    • Optionalbody: {
          company_name?: string;
          connect_partner_name?: null | string;
          is_sandbox?: boolean;
          name: string;
          webview_logo_shape?: "square" | "circle";
          webview_primary_button_color?: string;
          webview_primary_button_text_color?: string;
      }
      • Optionalcompany_name?: string
      • Optionalconnect_partner_name?: null | string

        use company_name

      • Optionalis_sandbox?: boolean
      • name: string
      • Optionalwebview_logo_shape?: "square" | "circle"
      • Optionalwebview_primary_button_color?: string
      • Optionalwebview_primary_button_text_color?: string

    Returns SeamHttpRequest<SetNonNullable<Required<{
        workspace: {
            company_name: string;
            connect_partner_name: null | string;
            is_sandbox: boolean;
            name: string;
            workspace_id: string;
        };
    }>, "workspace">, "workspace">

  • Parameters

    • Optionalbody: {}

      Returns SeamHttpRequest<SetNonNullable<Required<{
          workspace: {
              company_name: string;
              connect_partner_name: null | string;
              is_sandbox: boolean;
              name: string;
              workspace_id: string;
          };
      }>, "workspace">, "workspace">

    • Parameters

      • Optionalbody: {}

        Returns SeamHttpRequest<SetNonNullable<Required<{
            workspaces: {
                company_name: string;
                connect_partner_name: null | string;
                is_sandbox: boolean;
                name: string;
                workspace_id: string;
            }[];
        }>, "workspaces">, "workspaces">

      • Parameters

        Returns SeamHttpRequest<SetNonNullable<Required<{
            action_attempt:
                | {
                    action_attempt_id: string;
                    action_type: "LOCK_DOOR";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "LOCK_DOOR";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "LOCK_DOOR";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UNLOCK_DOOR";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UNLOCK_DOOR";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UNLOCK_DOOR";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SCAN_CREDENTIAL";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SCAN_CREDENTIAL";
                    error: null;
                    result: {
                        acs_credential_on_encoder: {
                            card_number: null | string;
                            created_at: null | string;
                            ends_at: null | string;
                            is_issued: null | boolean;
                            starts_at: null | string;
                            visionline_metadata?: {
                                cancelled: boolean;
                                card_format: (...) | (...);
                                card_holder?: (...) | (...);
                                card_id: string;
                                common_acs_entrance_ids?: (...) | (...);
                                discarded: boolean;
                                expired: boolean;
                                guest_acs_entrance_ids?: (...) | (...);
                                number_of_issued_cards: number;
                                overridden?: (...) | (...) | (...);
                                overwritten: boolean;
                                pending_auto_update: boolean;
                            };
                        };
                        acs_credential_on_seam: null | {
                            access_method: "code" | "card" | "mobile_key";
                            acs_credential_id: string;
                            acs_credential_pool_id?: string;
                            acs_system_id: string;
                            acs_user_id?: string;
                            card_number?: null | string;
                            code?: null | string;
                            created_at: string;
                            display_name: string;
                            ends_at?: string;
                            errors: {
                                error_code: ...;
                                message: ...;
                            }[];
                            external_type?:
                                | "pti_card"
                                | "brivo_credential"
                                | "hid_credential"
                                | "visionline_card"
                                | "salto_ks_credential";
                            external_type_display_name?: string;
                            is_issued?: boolean;
                            is_latest_desired_state_synced_with_provider?: boolean;
                            is_managed: true;
                            is_multi_phone_sync_credential?: boolean;
                            issued_at?: null | string;
                            latest_desired_state_synced_with_provider_at?: string;
                            parent_acs_credential_id?: string;
                            starts_at?: string;
                            visionline_metadata?: {
                                auto_join?: ...;
                                card_function_type: ...;
                                card_id?: ...;
                                common_acs_entrance_ids?: ...;
                                credential_id?: ...;
                                guest_acs_entrance_ids?: ...;
                                is_valid?: ...;
                                joiner_acs_credential_ids?: ...;
                            };
                            warnings: {
                                message: ...;
                                warning_code: ...;
                            }[];
                            workspace_id: string;
                        } | {
                            access_method: "code" | "card" | "mobile_key";
                            acs_credential_id: string;
                            acs_credential_pool_id?: string;
                            acs_system_id: string;
                            acs_user_id?: string;
                            card_number?: null | string;
                            code?: null | string;
                            created_at: string;
                            display_name: string;
                            ends_at?: string;
                            errors: {
                                error_code: ...;
                                message: ...;
                            }[];
                            external_type?:
                                | "pti_card"
                                | "brivo_credential"
                                | "hid_credential"
                                | "visionline_card"
                                | "salto_ks_credential";
                            external_type_display_name?: string;
                            is_issued?: boolean;
                            is_latest_desired_state_synced_with_provider?: boolean;
                            is_managed: false;
                            is_multi_phone_sync_credential?: boolean;
                            issued_at?: null | string;
                            latest_desired_state_synced_with_provider_at?: string;
                            parent_acs_credential_id?: string;
                            starts_at?: string;
                            visionline_metadata?: {
                                auto_join?: ...;
                                card_function_type: ...;
                                card_id?: ...;
                                common_acs_entrance_ids?: ...;
                                credential_id?: ...;
                                guest_acs_entrance_ids?: ...;
                                is_valid?: ...;
                                joiner_acs_credential_ids?: ...;
                            };
                            warnings: {
                                message: ...;
                                warning_code: ...;
                            }[];
                            workspace_id: string;
                        };
                        warnings: {
                            warning_code: "acs_credential_on_encoder_out_of_sync";
                            warning_message: string;
                        }[];
                    };
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SCAN_CREDENTIAL";
                    error: {
                        message: string;
                        type: "uncategorized_error";
                    } | {
                        message: string;
                        type: "action_attempt_expired";
                    } | {
                        message: string;
                        type: "no_card_on_encoder";
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "ENCODE_CREDENTIAL";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "ENCODE_CREDENTIAL";
                    error: null;
                    result: {
                        access_method: "code" | "card" | "mobile_key";
                        acs_credential_id: string;
                        acs_credential_pool_id?: string;
                        acs_system_id: string;
                        acs_user_id?: string;
                        card_number?: null | string;
                        code?: null | string;
                        created_at: string;
                        display_name: string;
                        ends_at?: string;
                        errors: {
                            error_code: string;
                            message: string;
                        }[];
                        external_type?:
                            | "pti_card"
                            | "brivo_credential"
                            | "hid_credential"
                            | "visionline_card"
                            | "salto_ks_credential";
                        external_type_display_name?: string;
                        is_issued?: boolean;
                        is_latest_desired_state_synced_with_provider?: boolean;
                        is_managed: true;
                        is_multi_phone_sync_credential?: boolean;
                        issued_at?: null | string;
                        latest_desired_state_synced_with_provider_at?: string;
                        parent_acs_credential_id?: string;
                        starts_at?: string;
                        visionline_metadata?: {
                            auto_join?: (...) | (...) | (...);
                            card_function_type: (...) | (...);
                            card_id?: (...) | (...);
                            common_acs_entrance_ids?: (...) | (...);
                            credential_id?: (...) | (...);
                            guest_acs_entrance_ids?: (...) | (...);
                            is_valid?: (...) | (...) | (...);
                            joiner_acs_credential_ids?: (...) | (...);
                        };
                        warnings: {
                            message: string;
                            warning_code: string;
                        }[];
                        workspace_id: string;
                    } | {
                        access_method: "code" | "card" | "mobile_key";
                        acs_credential_id: string;
                        acs_credential_pool_id?: string;
                        acs_system_id: string;
                        acs_user_id?: string;
                        card_number?: null | string;
                        code?: null | string;
                        created_at: string;
                        display_name: string;
                        ends_at?: string;
                        errors: {
                            error_code: string;
                            message: string;
                        }[];
                        external_type?:
                            | "pti_card"
                            | "brivo_credential"
                            | "hid_credential"
                            | "visionline_card"
                            | "salto_ks_credential";
                        external_type_display_name?: string;
                        is_issued?: boolean;
                        is_latest_desired_state_synced_with_provider?: boolean;
                        is_managed: false;
                        is_multi_phone_sync_credential?: boolean;
                        issued_at?: null | string;
                        latest_desired_state_synced_with_provider_at?: string;
                        parent_acs_credential_id?: string;
                        starts_at?: string;
                        visionline_metadata?: {
                            auto_join?: (...) | (...) | (...);
                            card_function_type: (...) | (...);
                            card_id?: (...) | (...);
                            common_acs_entrance_ids?: (...) | (...);
                            credential_id?: (...) | (...);
                            guest_acs_entrance_ids?: (...) | (...);
                            is_valid?: (...) | (...) | (...);
                            joiner_acs_credential_ids?: (...) | (...);
                        };
                        warnings: {
                            message: string;
                            warning_code: string;
                        }[];
                        workspace_id: string;
                    };
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "ENCODE_CREDENTIAL";
                    error:
                        | {
                            message: string;
                            type: "uncategorized_error";
                        }
                        | {
                            message: string;
                            type: "action_attempt_expired";
                        }
                        | {
                            message: string;
                            type: "no_card_on_encoder";
                        }
                        | {
                            message: string;
                            type: "incompatible_card_format";
                        };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "RESET_SANDBOX_WORKSPACE";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "RESET_SANDBOX_WORKSPACE";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "RESET_SANDBOX_WORKSPACE";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_COOL";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_COOL";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_COOL";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_HEAT";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_HEAT";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_HEAT";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_HEAT_COOL";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_HEAT_COOL";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_HEAT_COOL";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_FAN_MODE";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_FAN_MODE";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_FAN_MODE";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_THERMOSTAT_OFF";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_THERMOSTAT_OFF";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SET_THERMOSTAT_OFF";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "ACTIVATE_CLIMATE_PRESET";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "ACTIVATE_CLIMATE_PRESET";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "ACTIVATE_CLIMATE_PRESET";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SYNC_ACCESS_CODES";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SYNC_ACCESS_CODES";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "SYNC_ACCESS_CODES";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "CREATE_ACCESS_CODE";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "CREATE_ACCESS_CODE";
                    error: null;
                    result: {
                        access_code?: any;
                    };
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "CREATE_ACCESS_CODE";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "DELETE_ACCESS_CODE";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "DELETE_ACCESS_CODE";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "DELETE_ACCESS_CODE";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UPDATE_ACCESS_CODE";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UPDATE_ACCESS_CODE";
                    error: null;
                    result: {
                        access_code?: any;
                    };
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UPDATE_ACCESS_CODE";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "CREATE_NOISE_THRESHOLD";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "CREATE_NOISE_THRESHOLD";
                    error: null;
                    result: {
                        noise_threshold?: any;
                    };
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "CREATE_NOISE_THRESHOLD";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "DELETE_NOISE_THRESHOLD";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "DELETE_NOISE_THRESHOLD";
                    error: null;
                    result: {};
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "DELETE_NOISE_THRESHOLD";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UPDATE_NOISE_THRESHOLD";
                    error: null;
                    result: null;
                    status: "pending";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UPDATE_NOISE_THRESHOLD";
                    error: null;
                    result: {
                        noise_threshold?: any;
                    };
                    status: "success";
                }
                | {
                    action_attempt_id: string;
                    action_type: "UPDATE_NOISE_THRESHOLD";
                    error: {
                        message: string;
                        type: string;
                    };
                    result: null;
                    status: "error";
                };
        }>, "action_attempt">, "action_attempt">

      • Parameters

        • clientSessionToken: string

        Returns Promise<void>