feat: add delete noise threshold method (#182)

Author: itelo

docs/classes/Seam.md

@@ -7,29 +7,61 @@ const command: CommandModule<GlobalOptions> = {
   aliases: ["noise-thresholds", "nt"],
   describe: "interact with noise thresholds",
   builder: (yargs) => {
-    return yargs.demandCommand().command(
-      "list",
-      "list noise thresholds",
-      (yargs) => {
-        return yargs.option("device-id", {
-          describe: "filter by device ID",
-          demandOption: true,
-          type: "string",
-        })
-      },
-      async (argv) => {
-        await executeCommand(
-          "noiseThresholds.list",
-          [
-            {
-              device_id: argv.deviceId,
-            },
-          ],
-          argv
-        )
-      }
-    )
+    return yargs
+      .demandCommand()
+      .command(
+        "list",
+        "list noise thresholds",
+        (yargs) => {
+          return yargs.option("device-id", {
+            describe: "filter by device ID",
+            demandOption: true,
+            type: "string",
+          })
+        },
+        async (argv) => {
+          await executeCommand(
+            "noiseThresholds.list",
+            [
+              {
+                device_id: argv.deviceId,
+              },
+            ],
+            argv
+          )
+        }
+      )
+      .command(
+        "delete",
+        "delete 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,
+            })
+        },
+        async (argv) => {
+          await executeCommand(
+            "noiseThresholds.delete",
+            [
+              {
+                device_id: argv.device_id,
+                noise_threshold_id: argv.noise_threshold_id,
+              },
+            ],
+            argv
+          )
+        }
+      )
   },
+
   handler: () => {},
 }
 

docs/modules.md

@@ -35,6 +35,7 @@ import {
   WebhookCreateRequest,
   WebhookGetRequest,
   NoiseThresholdsListRequest,
+  NoiseThresholdsDeleteRequest,
 } from "../types/route-requests"
 import {
   AccessCodeCreateMultipleResponse,
@@ -405,6 +406,12 @@ export abstract class Routes {
           },
         }
       ),
+    delete: (params: NoiseThresholdsDeleteRequest) =>
+      this.makeRequest({
+        url: "/noise_sensors/noise_thresholds/delete",
+        method: "DELETE",
+        data: params,
+      }),
   }
 
   public readonly webhooks = {

src/cli/commands/noise-thresholds.ts

@@ -156,3 +156,8 @@ export interface EventsListRequest {
 export type NoiseThresholdsListRequest = {
   device_id: string
 }
+
+export type NoiseThresholdsDeleteRequest = {
+  device_id: string
+  noise_threshold_id: string
+}

src/seam-connect/routes.ts

@@ -15,6 +15,12 @@ type SeedLock = {
 type SeedNoiseSensors = {
   device_with_quiet_hours: Device<any, "minut">
   device_without_quiet_hours: Device<any, "minut">
+  noise_threshold_quiet_hours: {
+    noise_threshold_id: string
+  }
+  noise_threshold_normal_hours: {
+    noise_threshold_id: string
+  }
 }
 
 export type WorkerPublishedMessage = {

src/types/route-requests.ts

@@ -1,5 +1,6 @@
 import { Axios, AxiosResponse } from "axios"
 import getDeviceType from "./get-device-type"
+import { Device } from "../../../../src"
 
 const addFakeMinutDevices = async (axios: Axios) => {
   const defaultConfig = {
@@ -35,12 +36,32 @@ const addFakeMinutDevices = async (axios: Axios) => {
     sync: true,
   })
 
-  const devices = await getDeviceType(axios, "minut_sensor")
+  const devices: Device<any, "minut">[] = await getDeviceType(
+    axios,
+    "minut_sensor"
+  )
   const [device_with_quiet_hours, device_without_quiet_hours] = devices
+  const device_id = device_with_quiet_hours.device_id
+  const {
+    data: { noise_thresholds },
+  } = await axios.post("/noise_sensors/noise_thresholds/list", {
+    device_id,
+    sync: true,
+  })
+
+  const noise_threshold_normal_hours = (noise_thresholds as any[]).find(
+    (noise_threshold) => noise_threshold.name === "builtin_normal_hours"
+  )
+
+  const noise_threshold_quiet_hours = (noise_thresholds as any[]).find(
+    (noise_threshold) => noise_threshold.name === "builtin_quiet_hours"
+  )
 
   return {
     device_with_quiet_hours,
     device_without_quiet_hours,
+    noise_threshold_normal_hours,
+    noise_threshold_quiet_hours,
   }
 }
 

tests/fixtures/plugins/get-server-plugin.ts

@@ -16,6 +16,22 @@ test(
   "NoiseThresholds[]"
 )
 
+test(
+  testAPIMethod("noiseThresholds.delete"),
+  {
+    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,
+      },
+    ],
+    modifiesState: true,
+    load_devices_from: ["minut"],
+  },
+  "{}"
+)
+
 // Workspaces
 test(testAPIMethod("workspaces.list"), {}, "Workspace[]")
 test(testAPIMethod("workspaces.get"), {}, "Workspace")