Class SeamHttpNoiseSensorsNoiseThresholds

constructor

• new SeamHttpNoiseSensorsNoiseThresholds(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpNoiseSensorsNoiseThresholds

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

client

Readonlydefaults

create

• create(
      parameters: NoiseSensorsNoiseThresholdsCreateParameters,
      options?: NoiseSensorsNoiseThresholdsCreateOptions,
  ): NoiseSensorsNoiseThresholdsCreateRequest

  Creates a new noise threshold for a noise sensor. Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.

  Parameters

  • parameters: NoiseSensorsNoiseThresholdsCreateParameters
  • options: NoiseSensorsNoiseThresholdsCreateOptions = {}

  Returns NoiseSensorsNoiseThresholdsCreateRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(
      parameters: NoiseSensorsNoiseThresholdsDeleteParameters,
      options?: NoiseSensorsNoiseThresholdsDeleteOptions,
  ): NoiseSensorsNoiseThresholdsDeleteRequest

  Deletes a noise threshold from a noise sensor.

  Parameters

  • parameters: NoiseSensorsNoiseThresholdsDeleteParameters
  • options: NoiseSensorsNoiseThresholdsDeleteOptions = {}

  Returns NoiseSensorsNoiseThresholdsDeleteRequest

get

• get(
      parameters: NoiseSensorsNoiseThresholdsGetParameters,
      options?: NoiseSensorsNoiseThresholdsGetOptions,
  ): NoiseSensorsNoiseThresholdsGetRequest

  Returns a specified noise threshold for a noise sensor.

  Parameters

  • parameters: NoiseSensorsNoiseThresholdsGetParameters
  • options: NoiseSensorsNoiseThresholdsGetOptions = {}

  Returns NoiseSensorsNoiseThresholdsGetRequest

list

• list(
      parameters: NoiseSensorsNoiseThresholdsListParameters,
      options?: NoiseSensorsNoiseThresholdsListOptions,
  ): NoiseSensorsNoiseThresholdsListRequest

  Returns a list of all noise thresholds for a noise sensor.

  Parameters

  • parameters: NoiseSensorsNoiseThresholdsListParameters
  • options: NoiseSensorsNoiseThresholdsListOptions = {}

  Returns NoiseSensorsNoiseThresholdsListRequest

update

• update(
      parameters: NoiseSensorsNoiseThresholdsUpdateParameters,
      options?: NoiseSensorsNoiseThresholdsUpdateOptions,
  ): NoiseSensorsNoiseThresholdsUpdateRequest

  Updates a noise threshold for a noise sensor.

  Parameters

  • parameters: NoiseSensorsNoiseThresholdsUpdateParameters
  • options: NoiseSensorsNoiseThresholdsUpdateOptions = {}

  Returns NoiseSensorsNoiseThresholdsUpdateRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpNoiseSensorsNoiseThresholds

  Creates a new SeamHttpNoiseSensorsNoiseThresholds authenticated with an API key.

  Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpNoiseSensorsNoiseThresholds

  Creates a new SeamHttpNoiseSensorsNoiseThresholds from an existing HTTP client.

  Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpNoiseSensorsNoiseThresholds

  Creates a new SeamHttpNoiseSensorsNoiseThresholds authenticated with a client session token.

  Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpNoiseSensorsNoiseThresholds

  Creates a new SeamHttpNoiseSensorsNoiseThresholds authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpNoiseSensorsNoiseThresholds

  Creates a new SeamHttpNoiseSensorsNoiseThresholds authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpNoiseSensorsNoiseThresholds

StaticfromPublishableKey

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

  Creates a new SeamHttpNoiseSensorsNoiseThresholds authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpNoiseSensorsNoiseThresholds>