Class SeamHttpNoiseSensorsNoiseThresholds

constructor

• new SeamHttpNoiseSensorsNoiseThresholds(apiKeyOrOptions?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(parameters?, options?): NoiseSensorsNoiseThresholdsCreateRequest

• Parameters

  • Optionalparameters: {
        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
  • options: NoiseSensorsNoiseThresholdsCreateOptions = {}

  Returns NoiseSensorsNoiseThresholdsCreateRequest

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>

delete

• delete(parameters?, options?): NoiseSensorsNoiseThresholdsDeleteRequest

• Parameters

  • Optionalparameters: {
        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
  • options: NoiseSensorsNoiseThresholdsDeleteOptions = {}

  Returns NoiseSensorsNoiseThresholdsDeleteRequest

get

• get(parameters?, options?): NoiseSensorsNoiseThresholdsGetRequest

• Parameters

  • Optionalparameters: {
        noise_threshold_id: string;
    }

    • noise_threshold_id: string

      ID of the noise threshold that you want to get.
  • options: NoiseSensorsNoiseThresholdsGetOptions = {}

  Returns NoiseSensorsNoiseThresholdsGetRequest

list

• list(parameters?, options?): NoiseSensorsNoiseThresholdsListRequest

• Parameters

  • Optionalparameters: {
        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.
  • options: NoiseSensorsNoiseThresholdsListOptions = {}

  Returns NoiseSensorsNoiseThresholdsListRequest

update

• update(parameters?, options?): NoiseSensorsNoiseThresholdsUpdateRequest

• Parameters

  • Optionalparameters: {
        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
  • options: NoiseSensorsNoiseThresholdsUpdateOptions = {}

  Returns NoiseSensorsNoiseThresholdsUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromClient

• fromClient(client, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpNoiseSensorsNoiseThresholds>

• Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpNoiseSensorsNoiseThresholds>