Class SeamHttpNoiseSensorsNoiseThresholds

constructor

• new SeamHttpNoiseSensorsNoiseThresholds(apiKeyOrOptions?): SeamHttpNoiseSensorsNoiseThresholds

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpNoiseSensorsNoiseThresholds

client

Readonly defaults

create

• create(body?): SeamHttpRequest<SetNonNullable<Required<{
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          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

  • 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 SeamHttpRequest<SetNonNullable<Required<{
      action_attempt: {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result?: any;
          status: "success";
      } | {
          action_attempt_id: string;
          action_type: string;
          error: null;
          result: null;
          status: "pending";
      } | {
          action_attempt_id: string;
          action_type: string;
          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">

delete

• delete(body?): SeamHttpRequest<void, undefined>

• Parameters

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

    • device_id: string

    • noise_threshold_id: string

    • Optional sync?: boolean

  Returns SeamHttpRequest<void, undefined>

get

• get(body?): 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

  • Optional body: {
        noise_threshold_id: string;
    }

    • 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

• list(body?): 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

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

    • device_id: string

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

update

• update(body?): SeamHttpRequest<void, undefined>

• 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 SeamHttpRequest<void, undefined>

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>