Class SeamHttpNoiseSensorsNoiseThresholds

constructor

• new SeamHttpNoiseSensorsNoiseThresholds(apiKeyOrOptions?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

client

Readonly defaults

create

• create(body?): Promise<{
      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;
  }>

• Parameters

  • Optional body: {
        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

    • Optional name?: string

    • Optional noise_threshold_decibels?: number

    • Optional noise_threshold_nrs?: number

    • starts_daily_at: string

    • Optional sync?: boolean

  Returns Promise<{
      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;
  }>

delete

• delete(body?): Promise<void>

• Parameters

  • Optional body: {
        device_id: string;
        noise_threshold_id: string;
        sync?: boolean;
    }

    • device_id: string

    • noise_threshold_id: string

    • Optional sync?: boolean

  Returns Promise<void>

get

• get(body?): Promise<{
      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;
  }>

• Parameters

  • Optional body: {
        noise_threshold_id: string;
    }

    • noise_threshold_id: string

  Returns Promise<{
      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;
  }>

list

• list(body?): Promise<{
      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;
  }[]>

• Parameters

  • Optional body: {
        device_id: string;
        is_programmed?: boolean;
    }

    • device_id: string

    • Optional is_programmed?: boolean

  Returns Promise<{
      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;
  }[]>

update

• update(body?): Promise<void>

• Parameters

  • Optional body: {
        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

    • Optional ends_daily_at?: string

    • Optional name?: string

    • Optional noise_threshold_decibels?: number

    • noise_threshold_id: string

    • Optional noise_threshold_nrs?: number

    • Optional starts_daily_at?: string

    • Optional sync?: boolean

  Returns Promise<void>

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

Static fromClient

• fromClient(client, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

Static fromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

Static fromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

Static fromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpNoiseSensorsNoiseThresholds>