Class SeamHttpNoiseSensors

constructor

• new SeamHttpNoiseSensors(apiKeyOrOptions?): SeamHttpNoiseSensors

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpNoiseSensors

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

noiseThresholds

• get noiseThresholds(): SeamHttpNoiseSensorsNoiseThresholds

• Returns SeamHttpNoiseSensorsNoiseThresholds

simulate

• get simulate(): SeamHttpNoiseSensorsSimulate

• Returns SeamHttpNoiseSensorsSimulate

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>

list

• list(parameters?, options?): NoiseSensorsListRequest

• Parameters

  • Optionalparameters: {
        connect_webview_id?: string;
        connected_account_id?: string;
        connected_account_ids?: string[];
        created_before?: Date;
        custom_metadata_has?: Record<string, string | boolean>;
        customer_ids?: string[];
        device_ids?: string[];
        device_type?: "noiseaware_activity_zone" | "minut_sensor";
        device_types?: ("noiseaware_activity_zone" | "minut_sensor")[];
        exclude_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection")[];
        include_if?: (
            | "can_remotely_unlock"
            | "can_remotely_lock"
            | "can_program_offline_access_codes"
            | "can_program_online_access_codes"
            | "can_hvac_heat"
            | "can_hvac_cool"
            | "can_hvac_heat_cool"
            | "can_turn_off_hvac"
            | "can_simulate_removal"
            | "can_simulate_connection"
            | "can_simulate_disconnection")[];
        limit?: number;
        manufacturer?: "noiseaware" | "minut";
        page_cursor?: null | string;
        space_id?: string;
        unstable_location_id?: null | string;
        user_identifier_key?: string;
    }

    • Optionalconnect_webview_id?: string

      ID of the Connect Webview for which you want to list devices.

    • Optionalconnected_account_id?: string

      ID of the connected account for which you want to list devices.

    • Optionalconnected_account_ids?: string[]

      Array of IDs of the connected accounts for which you want to list devices.

    • Optionalcreated_before?: Date

      Timestamp by which to limit returned devices. Returns devices created before this timestamp.

    • Optionalcustom_metadata_has?: Record<string, string | boolean>

      Set of key:value custom metadata pairs for which you want to list devices.

    • Optionalcustomer_ids?: string[]

    • Optionaldevice_ids?: string[]

      Array of device IDs for which you want to list devices.

    • Optionaldevice_type?: "noiseaware_activity_zone" | "minut_sensor"

      Device type of the noise sensors that you want to list.

    • Optionaldevice_types?: ("noiseaware_activity_zone" | "minut_sensor")[]

      Device types of the noise sensors that you want to list.

    • Optionalexclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection")[]

    • Optionalinclude_if?: (
          | "can_remotely_unlock"
          | "can_remotely_lock"
          | "can_program_offline_access_codes"
          | "can_program_online_access_codes"
          | "can_hvac_heat"
          | "can_hvac_cool"
          | "can_hvac_heat_cool"
          | "can_turn_off_hvac"
          | "can_simulate_removal"
          | "can_simulate_connection"
          | "can_simulate_disconnection")[]

    • Optionallimit?: number

      Numerical limit on the number of devices to return.

    • Optionalmanufacturer?: "noiseaware" | "minut"

      Manufacturers of the noise sensors that you want to list.

    • Optionalpage_cursor?: null | string

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalspace_id?: string

      ID of the space for which you want to list devices.

    • Optionalunstable_location_id?: null | string

      Deprecated

      Use space_id.

    • Optionaluser_identifier_key?: string

      Your own internal user ID for the user for which you want to list devices.
  • options: NoiseSensorsListOptions = {}

  Returns NoiseSensorsListRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpNoiseSensors

• Parameters

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

  Returns SeamHttpNoiseSensors

StaticfromClient

• fromClient(client, options?): SeamHttpNoiseSensors

• Parameters

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

  Returns SeamHttpNoiseSensors

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpNoiseSensors

• Parameters

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

  Returns SeamHttpNoiseSensors

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpNoiseSensors

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpNoiseSensors

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpNoiseSensors>