feat: add update noise threshold method (#187)

* feat: add update noise threshold method

* fix issue in create noise sensor test

Author: itelo

docs/classes/Seam.md

@@ -86,6 +86,67 @@ const command: CommandModule<GlobalOptions> = {
           )
         }
       )
+      .command(
+        "update",
+        "update a noise threshold",
+        (yargs) => {
+          return yargs
+            .option("device_id", {
+              describe: "the device ID",
+              type: "string",
+              demandOption: true,
+            })
+            .option("noise_threshold_id", {
+              describe: "the noise threshold ID",
+              type: "string",
+              demandOption: true,
+            })
+            .option("name", {
+              describe: "the name of the noise threshold",
+              type: "string",
+              demandOption: false,
+            })
+            .option("starts_daily_at", {
+              describe: "the time the noise threshold starts",
+              type: "string",
+              demandOption: false,
+            })
+            .option("ends_daily_at", {
+              describe: "the time the noise threshold ends",
+              type: "string",
+              demandOption: false,
+            })
+            .option("noise_threshold_decibels", {
+              describe: "the noise threshold in decibels",
+              type: "number",
+              demandOption: false,
+              conflicts: "noise_threshold_nrs",
+            })
+            .option("noise_threshold_nrs", {
+              describe: "the noise threshold in NRS",
+              type: "number",
+              demandOption: false,
+              conflicts: "noise_threshold_decibels",
+            })
+        },
+        async (argv) => {
+          await executeCommand(
+            "noiseThresholds.update",
+            [
+              {
+                device_id: argv.device_id,
+                noise_threshold_id: argv.noise_threshold_id,
+                name: argv.name,
+                starts_daily_at: argv.starts_daily_at,
+                ends_daily_at: argv.ends_daily_at,
+                noise_threshold_decibels: argv.noise_threshold_decibels,
+                noise_threshold_nrs: argv.noise_threshold_nrs,
+              },
+            ],
+            argv
+          )
+        }
+      )
       .command(
         "delete",
         "delete a noise threshold",

docs/modules.md

@@ -37,6 +37,7 @@ import {
   NoiseThresholdsListRequest,
   NoiseThresholdsDeleteRequest,
   NoiseThresholdsCreateRequest,
+  NoiseThresholdsUpdateRequest,
 } from "../types/route-requests"
 import {
   AccessCodeCreateMultipleResponse,
@@ -413,6 +414,12 @@ export abstract class Routes {
         method: "POST",
         data: params,
       }),
+    update: (params: NoiseThresholdsUpdateRequest) =>
+      this.makeRequest({
+        url: "/noise_sensors/noise_thresholds/update",
+        method: "POST",
+        data: params,
+      }),
     delete: (params: NoiseThresholdsDeleteRequest) =>
       this.makeRequest({
         url: "/noise_sensors/noise_thresholds/delete",

src/cli/commands/noise-thresholds.ts

@@ -169,6 +169,19 @@ export type NoiseThresholdsCreateRequest = {
   noise_threshold_nrs?: number
 }
 
+export type NoiseThresholdsUpdateRequest = {
+  device_id: string
+  noise_threshold_id: string
+  name?: string
+  starts_daily_at?: string
+  ends_daily_at?: string
+  noise_threshold_decibels?: number
+  /**
+   * only available for NoiseAware devices
+   */
+  noise_threshold_nrs?: number
+}
+
 export type NoiseThresholdsDeleteRequest = {
   device_id: string
   noise_threshold_id: string

src/seam-connect/routes.ts

@@ -23,7 +23,26 @@ test(
       {
         device_id: seed.devices.minut.device_without_quiet_hours.device_id,
         starts_daily_at: "13:00:00[America/Los_Angeles]",
-        ends_daily_at: "13:00:00[America/Los_Angeles]",
+        ends_daily_at: "14:00:00[America/Los_Angeles]",
+        noise_threshold_decibels: 80,
+      },
+    ],
+    modifiesState: true,
+    load_devices_from: ["minut"],
+  },
+  "{}"
+)
+
+test(
+  testAPIMethod("noiseThresholds.update"),
+  {
+    args: (seed) => [
+      {
+        noise_threshold_id:
+          seed.devices.minut.noise_threshold_quiet_hours.noise_threshold_id,
+        device_id: seed.devices.minut.device_with_quiet_hours.device_id,
+        starts_daily_at: "19:00:00[America/Los_Angeles]",
+        ends_daily_at: "21:00:00[America/Los_Angeles]",
         noise_threshold_decibels: 80,
       },
     ],