Class SeamHttpNoiseSensorsNoiseThresholds

Index

Constructors

Properties

Methods

create createPaginator delete get list update updateClientSessionToken fromApiKey fromClient fromClientSessionToken fromConsoleSessionToken fromPersonalAccessToken fromPublishableKey

Constructors

constructor

new SeamHttpNoiseSensorsNoiseThresholds(apiKeyOrOptions?): SeamHttpNoiseSensorsNoiseThresholds
Parameters
- apiKeyOrOptions: string | SeamHttpOptions = {}
Returns SeamHttpNoiseSensorsNoiseThresholds
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:45

Properties

client

client: AxiosInstance

`Readonly`defaults

defaults: Required<SeamHttpRequestOptions>

`Readonly`ltsVersion

ltsVersion: "1.0.0" = seamApiLtsVersion

`Static`ltsVersion

ltsVersion: string = seamApiLtsVersion

Methods

create

create(body?): 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;
                    assa_abloy_vostio_metadata?: {
                        auto_join?: ...;
                        door_names?: ...;
                        endpoint_id?: ...;
                        key_id?: ...;
                        key_issuing_request_id?: ...;
                        override_guest_acs_entrance_ids?: ...;
                    };
                    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"
                        | "assa_abloy_vostio_key"
                        | "salto_space_key"
                        | "latch_access";
                    external_type_display_name?: string;
                    is_issued?: boolean;
                    is_latest_desired_state_synced_with_provider?: null | 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?: null | 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;
                    assa_abloy_vostio_metadata?: {
                        auto_join?: ...;
                        door_names?: ...;
                        endpoint_id?: ...;
                        key_id?: ...;
                        key_issuing_request_id?: ...;
                        override_guest_acs_entrance_ids?: ...;
                    };
                    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"
                        | "assa_abloy_vostio_key"
                        | "salto_space_key"
                        | "latch_access";
                    external_type_display_name?: string;
                    is_issued?: boolean;
                    is_latest_desired_state_synced_with_provider?: null | 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?: null | 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_ACCESS_METHOD";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "ENCODE_ACCESS_METHOD";
            error: null;
            result: {
                access_method_id: string;
                created_at: string;
                display_name: string;
                instant_key_url?: string;
                is_card_encoding_required?: boolean;
                issued_at?: string;
                mode: "code" | "card" | "mobile_key";
                workspace_id: string;
            };
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "ENCODE_ACCESS_METHOD";
            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";
                }
                | {
                    message: string;
                    type: "credential_cannot_be_reissued";
                };
            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;
                assa_abloy_vostio_metadata?: {
                    auto_join?: (...) | (...) | (...);
                    door_names?: (...) | (...);
                    endpoint_id?: (...) | (...);
                    key_id?: (...) | (...);
                    key_issuing_request_id?: (...) | (...);
                    override_guest_acs_entrance_ids?: (...) | (...);
                };
                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"
                    | "assa_abloy_vostio_key"
                    | "salto_space_key"
                    | "latch_access";
                external_type_display_name?: string;
                is_issued?: boolean;
                is_latest_desired_state_synced_with_provider?: null | 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?: null | 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: ...;
                    }
                    | {
                        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;
                assa_abloy_vostio_metadata?: {
                    auto_join?: (...) | (...) | (...);
                    door_names?: (...) | (...);
                    endpoint_id?: (...) | (...);
                    key_id?: (...) | (...);
                    key_issuing_request_id?: (...) | (...);
                    override_guest_acs_entrance_ids?: (...) | (...);
                };
                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"
                    | "assa_abloy_vostio_key"
                    | "salto_space_key"
                    | "latch_access";
                external_type_display_name?: string;
                is_issued?: boolean;
                is_latest_desired_state_synced_with_provider?: null | 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?: null | 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: ...;
                    }
                    | {
                        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";
                }
                | {
                    message: string;
                    type: "credential_cannot_be_reissued";
                };
            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: "SIMULATE_KEYPAD_CODE_ENTRY";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
            error: null;
            result: {};
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
            error: null;
            result: {};
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        }
        | {
            action_attempt_id: string;
            action_type: "PUSH_THERMOSTAT_PROGRAMS";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "PUSH_THERMOSTAT_PROGRAMS";
            error: null;
            result: {};
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "PUSH_THERMOSTAT_PROGRAMS";
            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;
    };
}>, "action_attempt" | "noise_threshold">, "noise_threshold">
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
    ID of the device for which you want to create a noise threshold.
  - ends_daily_at: string
    Time at which the new noise threshold should become inactive daily.
  - Optionalname?: string
    Name of the new noise threshold.
  - Optionalnoise_threshold_decibels?: number
    Noise level in decibels for the new noise threshold.
  - Optionalnoise_threshold_nrs?: number
    Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for Noiseaware sensors.
  - starts_daily_at: string
    Time at which the new noise threshold should become active daily.
  - 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;
                    assa_abloy_vostio_metadata?: {
                        auto_join?: ...;
                        door_names?: ...;
                        endpoint_id?: ...;
                        key_id?: ...;
                        key_issuing_request_id?: ...;
                        override_guest_acs_entrance_ids?: ...;
                    };
                    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"
                        | "assa_abloy_vostio_key"
                        | "salto_space_key"
                        | "latch_access";
                    external_type_display_name?: string;
                    is_issued?: boolean;
                    is_latest_desired_state_synced_with_provider?: null | 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?: null | 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;
                    assa_abloy_vostio_metadata?: {
                        auto_join?: ...;
                        door_names?: ...;
                        endpoint_id?: ...;
                        key_id?: ...;
                        key_issuing_request_id?: ...;
                        override_guest_acs_entrance_ids?: ...;
                    };
                    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"
                        | "assa_abloy_vostio_key"
                        | "salto_space_key"
                        | "latch_access";
                    external_type_display_name?: string;
                    is_issued?: boolean;
                    is_latest_desired_state_synced_with_provider?: null | 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?: null | 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_ACCESS_METHOD";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "ENCODE_ACCESS_METHOD";
            error: null;
            result: {
                access_method_id: string;
                created_at: string;
                display_name: string;
                instant_key_url?: string;
                is_card_encoding_required?: boolean;
                issued_at?: string;
                mode: "code" | "card" | "mobile_key";
                workspace_id: string;
            };
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "ENCODE_ACCESS_METHOD";
            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";
                }
                | {
                    message: string;
                    type: "credential_cannot_be_reissued";
                };
            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;
                assa_abloy_vostio_metadata?: {
                    auto_join?: (...) | (...) | (...);
                    door_names?: (...) | (...);
                    endpoint_id?: (...) | (...);
                    key_id?: (...) | (...);
                    key_issuing_request_id?: (...) | (...);
                    override_guest_acs_entrance_ids?: (...) | (...);
                };
                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"
                    | "assa_abloy_vostio_key"
                    | "salto_space_key"
                    | "latch_access";
                external_type_display_name?: string;
                is_issued?: boolean;
                is_latest_desired_state_synced_with_provider?: null | 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?: null | 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: ...;
                    }
                    | {
                        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;
                assa_abloy_vostio_metadata?: {
                    auto_join?: (...) | (...) | (...);
                    door_names?: (...) | (...);
                    endpoint_id?: (...) | (...);
                    key_id?: (...) | (...);
                    key_issuing_request_id?: (...) | (...);
                    override_guest_acs_entrance_ids?: (...) | (...);
                };
                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"
                    | "assa_abloy_vostio_key"
                    | "salto_space_key"
                    | "latch_access";
                external_type_display_name?: string;
                is_issued?: boolean;
                is_latest_desired_state_synced_with_provider?: null | 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?: null | 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: ...;
                    }
                    | {
                        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";
                }
                | {
                    message: string;
                    type: "credential_cannot_be_reissued";
                };
            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: "SIMULATE_KEYPAD_CODE_ENTRY";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
            error: null;
            result: {};
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_KEYPAD_CODE_ENTRY";
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
            error: null;
            result: {};
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "SIMULATE_MANUAL_LOCK_VIA_KEYPAD";
            error: {
                message: string;
                type: string;
            };
            result: null;
            status: "error";
        }
        | {
            action_attempt_id: string;
            action_type: "PUSH_THERMOSTAT_PROGRAMS";
            error: null;
            result: null;
            status: "pending";
        }
        | {
            action_attempt_id: string;
            action_type: "PUSH_THERMOSTAT_PROGRAMS";
            error: null;
            result: {};
            status: "success";
        }
        | {
            action_attempt_id: string;
            action_type: "PUSH_THERMOSTAT_PROGRAMS";
            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;
    };
}>, "action_attempt" | "noise_threshold">, "noise_threshold">
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:169

createPaginator

createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>
Type Parameters
- const TResponse
- const TResponseKey extends string | number | symbol
Parameters
- request: SeamHttpRequest<TResponse, TResponseKey>
Returns SeamPaginator<TResponse, TResponseKey>
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:144

delete

delete(params?): SeamHttpRequest<void, undefined>
Parameters
- Optionalparams: {
      device_id: string;
      noise_threshold_id: string;
      sync?: boolean;
  }
  - device_id: string
    ID of the device that contains the noise threshold that you want to delete.
  - noise_threshold_id: string
    ID of the noise threshold that you want to delete.
  - Optionalsync?: boolean
Returns SeamHttpRequest<void, undefined>
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:183

get

get(params?): 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
- Optionalparams: {
  noise_threshold_id: string;
  }
  - noise_threshold_id: string
    ID of the noise threshold that you want to get.
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">
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:194

list

list(params?): 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
- Optionalparams: {
  device_id: string;
  is_programmed?: boolean;
  }
  - device_id: string
    ID of the device for which you want to list noise thresholds.
  - Optionalis_programmed?: boolean
    Enables you to limit the returned noise thresholds by whether they are programmed on the noise sensor. To list only noise thresholds that are programmed on the noise sensor, set this parameter to true. To list only noise thresholds that are not programmed on the noise sensor, se this parameter to false.
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">
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:208

update

update(body?): SeamHttpRequest<void, undefined>
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
    ID of the device that contains the noise threshold that you want to update.
  - Optionalends_daily_at?: string
    Time at which the noise threshold should become inactive daily.
  - Optionalname?: string
    Name of the noise threshold that you want to update.
  - Optionalnoise_threshold_decibels?: number
    Noise level in decibels for the noise threshold.
  - noise_threshold_id: string
    ID of the noise threshold that you want to update.
  - Optionalnoise_threshold_nrs?: number
    Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for Noiseaware sensors.
  - Optionalstarts_daily_at?: string
    Time at which the noise threshold should become active daily.
  - Optionalsync?: boolean
Returns SeamHttpRequest<void, undefined>
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:222

updateClientSessionToken

updateClientSessionToken(clientSessionToken): Promise<void>
Parameters
- clientSessionToken: string
Returns Promise<void>
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:150

`Static`fromApiKey

fromApiKey(apiKey, options?): SeamHttpNoiseSensorsNoiseThresholds
Parameters
- apiKey: string
- options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}
Returns SeamHttpNoiseSensorsNoiseThresholds
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:62

`Static`fromClient

fromClient(client, options?): SeamHttpNoiseSensorsNoiseThresholds
Parameters
- client: AxiosInstance
- options: Omit<SeamHttpOptionsWithClient, "client"> = {}
Returns SeamHttpNoiseSensorsNoiseThresholds
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:51

`Static`fromClientSessionToken

fromClientSessionToken(clientSessionToken, options?): SeamHttpNoiseSensorsNoiseThresholds
Parameters
- clientSessionToken: string
- options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}
Returns SeamHttpNoiseSensorsNoiseThresholds
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:73

`Static`fromConsoleSessionToken

fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpNoiseSensorsNoiseThresholds
Parameters
- consoleSessionToken: string
- workspaceId: string
- options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}
Returns SeamHttpNoiseSensorsNoiseThresholds
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:110

`Static`fromPersonalAccessToken

fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpNoiseSensorsNoiseThresholds
Parameters
- personalAccessToken: string
- workspaceId: string
- options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}
Returns SeamHttpNoiseSensorsNoiseThresholds
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:127

`Static`fromPublishableKey

fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpNoiseSensorsNoiseThresholds>
Parameters
- publishableKey: string
- userIdentifierKey: string
- options: SeamHttpFromPublishableKeyOptions = {}
Returns Promise<SeamHttpNoiseSensorsNoiseThresholds>
- Defined in src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts:87

Class SeamHttpNoiseSensorsNoiseThresholds

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SeamHttpNoiseSensorsNoiseThresholds

Properties

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

Methods

create

Parameters

device_id: string

ends_daily_at: string

Optionalname?: string

Optionalnoise_threshold_decibels?: number

Optionalnoise_threshold_nrs?: number

starts_daily_at: string

Optionalsync?: boolean

createPaginator

Type Parameters

Parameters

Returns SeamPaginator<TResponse, TResponseKey>

delete

Parameters

device_id: string

noise_threshold_id: string

Optionalsync?: boolean

Returns SeamHttpRequest<void, undefined>

get

Parameters

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">

list

Parameters

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">

update

Parameters

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>

updateClientSessionToken

Parameters

Returns Promise<void>

StaticfromApiKey

Parameters

Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromClient

Parameters

Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromClientSessionToken

Parameters

Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromConsoleSessionToken

Parameters

Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromPersonalAccessToken

Parameters

Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromPublishableKey

Parameters

Returns Promise<SeamHttpNoiseSensorsNoiseThresholds>

Settings

On This Page

`Readonly`defaults

`Readonly`ltsVersion

`Static`ltsVersion

`Optional`name?: string

`Optional`noise_threshold_decibels?: number

`Optional`noise_threshold_nrs?: number

`Optional`sync?: boolean

`Optional`sync?: boolean

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">

`Optional`is_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">

`Optional`ends_daily_at?: string

`Optional`name?: string

`Optional`noise_threshold_decibels?: number

`Optional`noise_threshold_nrs?: number

`Optional`starts_daily_at?: string

`Optional`sync?: boolean

`Static`fromApiKey

`Static`fromClient

`Static`fromClientSessionToken

`Static`fromConsoleSessionToken

`Static`fromPersonalAccessToken

`Static`fromPublishableKey