Class SeamHttpNoiseSensorsNoiseThresholds

Constructors

Properties

client: AxiosInstance
defaults: Required<SeamHttpRequestOptions>

Methods

  • Parameters

    • Optionalbody: {
          device_id: string;
          ends_daily_at: string;
          name?: string;
          noise_threshold_decibels?: number;
          noise_threshold_nrs?: number;
          starts_daily_at: string;
          sync?: boolean;
      }
      • device_id: string
      • ends_daily_at: string
      • Optionalname?: string
      • Optionalnoise_threshold_decibels?: number
      • Optionalnoise_threshold_nrs?: number
      • starts_daily_at: string
      • Optionalsync?: boolean

    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: null | {
                        card_number: null | string;
                        created_at: null | string;
                        ends_at: null | string;
                        is_issued: null | boolean;
                        starts_at: null | string;
                        visionline_metadata?: {
                            cancelled: ...;
                            card_format: ...;
                            card_holder?: ...;
                            card_id: ...;
                            common_acs_entrance_ids?: ...;
                            discarded: ...;
                            expired: ...;
                            guest_acs_entrance_ids?: ...;
                            number_of_issued_cards: ...;
                            overridden?: ...;
                            overwritten: ...;
                            pending_auto_update: ...;
                        };
                    };
                    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;
                        is_one_time_use?: 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: (
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...))[];
                        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;
                        is_one_time_use?: 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: (
                            | (...)
                            | (...)
                            | (...)
                            | (...)
                            | (...))[];
                        workspace_id: string;
                    };
                    warnings: {
                        warning_code: "acs_credential_on_encoder_out_of_sync" | "acs_credential_on_seam_not_found";
                        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_credential_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;
                    is_one_time_use?: 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: (
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            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: 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;
                    is_one_time_use?: 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: (
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        }
                        | {
                            created_at: ...;
                            message: ...;
                            warning_code: ...;
                        })[];
                    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_credential_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_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_HVAC_MODE";
                error: null;
                result: null;
                status: "pending";
            }
            | {
                action_attempt_id: string;
                action_type: "SET_HVAC_MODE";
                error: null;
                result: {};
                status: "success";
            }
            | {
                action_attempt_id: string;
                action_type: "SET_HVAC_MODE";
                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";
            };
        noise_threshold: {
            device_id: string;
            ends_daily_at: string;
            name: string;
            noise_threshold_decibels: number;
            noise_threshold_id: string;
            noise_threshold_nrs?: number;
            starts_daily_at: string;
        };
    }>, "noise_threshold" | "action_attempt">, "noise_threshold">

  • Parameters

    • Optionalbody: {
          device_id: string;
          noise_threshold_id: string;
          sync?: boolean;
      }
      • device_id: string
      • noise_threshold_id: string
      • Optionalsync?: boolean

    Returns SeamHttpRequest<void, undefined>

  • Parameters

    • Optionalbody: {
          noise_threshold_id: string;
      }
      • noise_threshold_id: string

    Returns SeamHttpRequest<SetNonNullable<Required<{
        noise_threshold: {
            device_id: string;
            ends_daily_at: string;
            name: string;
            noise_threshold_decibels: number;
            noise_threshold_id: string;
            noise_threshold_nrs?: number;
            starts_daily_at: string;
        };
    }>, "noise_threshold">, "noise_threshold">

  • Parameters

    • Optionalbody: {
          device_id: string;
          is_programmed?: boolean;
      }
      • device_id: string
      • Optionalis_programmed?: boolean

    Returns SeamHttpRequest<SetNonNullable<Required<{
        noise_thresholds: {
            device_id: string;
            ends_daily_at: string;
            name: string;
            noise_threshold_decibels: number;
            noise_threshold_id: string;
            noise_threshold_nrs?: number;
            starts_daily_at: string;
        }[];
    }>, "noise_thresholds">, "noise_thresholds">

  • Parameters

    • Optionalbody: {
          device_id: string;
          ends_daily_at?: string;
          name?: string;
          noise_threshold_decibels?: number;
          noise_threshold_id: string;
          noise_threshold_nrs?: number;
          starts_daily_at?: string;
          sync?: boolean;
      }
      • device_id: string
      • Optionalends_daily_at?: string
      • Optionalname?: string
      • Optionalnoise_threshold_decibels?: number
      • noise_threshold_id: string
      • Optionalnoise_threshold_nrs?: number
      • Optionalstarts_daily_at?: string
      • Optionalsync?: boolean

    Returns SeamHttpRequest<void, undefined>

  • Parameters

    • clientSessionToken: string

    Returns Promise<void>