@seamapi/http 2.4.0 → 2.4.2

package/src/lib/routes/locks/locks.ts

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { ActionAttempt } from 'lib/resources/action-attempt.js'
 import type { Device } from 'lib/resources/device.js'
 import { SeamHttpActionAttempts } from 'lib/routes/action-attempts/index.js'
@@ -173,6 +177,8 @@ export class SeamHttpLocks {
     parameters: LocksConfigureAutoLockParameters,
     options: LocksConfigureAutoLockOptions = {},
   ): LocksConfigureAutoLockRequest {
+    assertValidRequestParameters(parameters, '/locks/configure_auto_lock', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/locks/configure_auto_lock',
       method: 'POST',
@@ -191,13 +197,15 @@ export class SeamHttpLocks {
    * @deprecated Use `/devices/get` instead.
    */
   get(
-    parameters?: LocksGetParameters,
+    parameters: LocksGetParameters,
     options: LocksGetOptions = {},
   ): LocksGetRequest {
+    assertValidRequestParameters(parameters, '/locks/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/locks/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'device',
       options,
     })
@@ -210,6 +218,8 @@ export class SeamHttpLocks {
     parameters?: LocksListParameters,
     options: LocksListOptions = {},
   ): LocksListRequest {
+    assertValidRequestParameters(parameters, '/locks/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/locks/list',
       method: 'POST',
@@ -226,6 +236,8 @@ export class SeamHttpLocks {
     parameters: LocksLockDoorParameters,
     options: LocksLockDoorOptions = {},
   ): LocksLockDoorRequest {
+    assertValidRequestParameters(parameters, '/locks/lock_door', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/locks/lock_door',
       method: 'POST',
@@ -246,6 +258,8 @@ export class SeamHttpLocks {
     parameters: LocksUnlockDoorParameters,
     options: LocksUnlockDoorOptions = {},
   ): LocksUnlockDoorRequest {
+    assertValidRequestParameters(parameters, '/locks/unlock_door', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/locks/unlock_door',
       method: 'POST',
@@ -291,7 +305,7 @@ export type LocksConfigureAutoLockOptions = Pick<
   'waitForActionAttempt'
 >
 
-export type LocksGetParameters = {
+export type LocksGetParameters = RequireAtLeastOne<{
   /**
    * ID of the lock that you want to get.
    */
@@ -300,7 +314,7 @@ export type LocksGetParameters = {
    * Name of the lock that you want to get.
    */
   name?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use LocksGetRequest instead.
@@ -320,26 +334,10 @@ export type LocksListParameters = {
    * ID of the connected account for which you want to list devices.
    */
   connected_account_id?: string | undefined
-  /**
-   * Array of IDs of the connected accounts for which you want to list devices.
-   */
-  connected_account_ids?: Array<string> | undefined
-  /**
-   * Timestamp by which to limit returned devices. Returns devices created before this timestamp.
-   */
-  created_before?: string | undefined
-  /**
-   * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
-   */
-  custom_metadata_has?: Record<string, unknown> | undefined
   /**
    * Customer key for which you want to list devices.
    */
   customer_key?: string | undefined
-  /**
-   * Array of device IDs for which you want to list devices.
-   */
-  device_ids?: Array<string> | undefined
   /**
    * Device type of the locks that you want to list.
    */
@@ -370,6 +368,7 @@ export type LocksListParameters = {
     | 'tedee_lock'
     | 'akiles_lock'
     | 'ultraloq_lock'
+    | 'yacan_lock'
     | 'keyincode_lock'
     | 'omnitec_lock'
     | 'kisi_lock'
@@ -406,16 +405,13 @@ export type LocksListParameters = {
         | 'tedee_lock'
         | 'akiles_lock'
         | 'ultraloq_lock'
+        | 'yacan_lock'
         | 'keyincode_lock'
         | 'omnitec_lock'
         | 'kisi_lock'
         | 'aqara_lock'
       >
     | undefined
-  /**
-   * Numerical limit on the number of devices to return.
-   */
-  limit?: number | undefined
   /**
    * Manufacturer of the locks that you want to list.
    */
@@ -452,27 +448,8 @@ export type LocksListParameters = {
     | 'ultraloq'
     | 'omnitec'
     | 'kisi'
+    | 'yacan'
     | undefined
-  /**
-   * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
-   */
-  page_cursor?: string | undefined
-  /**
-   * String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
-   */
-  search?: string | undefined
-  /**
-   * ID of the space for which you want to list devices.
-   */
-  space_id?: string | undefined
-  /**
-   * @deprecated Use `space_id`.
-   */
-  unstable_location_id?: string | undefined
-  /**
-   * Your own internal user ID for the user for which you want to list devices.
-   */
-  user_identifier_key?: string | undefined
 }
 
 /**

package/src/lib/routes/locks/simulate/simulate.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { ActionAttempt } from 'lib/resources/action-attempt.js'
 import { SeamHttpActionAttempts } from 'lib/routes/action-attempts/index.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
@@ -166,6 +167,12 @@ export class SeamHttpLocksSimulate {
     parameters: LocksSimulateKeypadCodeEntryParameters,
     options: LocksSimulateKeypadCodeEntryOptions = {},
   ): LocksSimulateKeypadCodeEntryRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/locks/simulate/keypad_code_entry',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/locks/simulate/keypad_code_entry',
       method: 'POST',
@@ -186,6 +193,12 @@ export class SeamHttpLocksSimulate {
     parameters: LocksSimulateManualLockViaKeypadParameters,
     options: LocksSimulateManualLockViaKeypadOptions = {},
   ): LocksSimulateManualLockViaKeypadRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/locks/simulate/manual_lock_via_keypad',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/locks/simulate/manual_lock_via_keypad',
       method: 'POST',

package/src/lib/routes/noise-sensors/noise-sensors.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { Device } from 'lib/resources/device.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -179,6 +180,8 @@ export class SeamHttpNoiseSensors {
     parameters?: NoiseSensorsListParameters,
     options: NoiseSensorsListOptions = {},
   ): NoiseSensorsListRequest {
+    assertValidRequestParameters(parameters, '/noise_sensors/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/list',
       method: 'POST',
@@ -198,26 +201,10 @@ export type NoiseSensorsListParameters = {
    * ID of the connected account for which you want to list devices.
    */
   connected_account_id?: string | undefined
-  /**
-   * Array of IDs of the connected accounts for which you want to list devices.
-   */
-  connected_account_ids?: Array<string> | undefined
-  /**
-   * Timestamp by which to limit returned devices. Returns devices created before this timestamp.
-   */
-  created_before?: string | undefined
-  /**
-   * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
-   */
-  custom_metadata_has?: Record<string, unknown> | undefined
   /**
    * Customer key for which you want to list devices.
    */
   customer_key?: string | undefined
-  /**
-   * Array of device IDs for which you want to list devices.
-   */
-  device_ids?: Array<string> | undefined
   /**
    * Device type of the noise sensors that you want to list.
    */
@@ -226,34 +213,10 @@ export type NoiseSensorsListParameters = {
    * Device types of the noise sensors that you want to list.
    */
   device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined
-  /**
-   * Numerical limit on the number of devices to return.
-   */
-  limit?: number | undefined
   /**
    * Manufacturers of the noise sensors that you want to list.
    */
   manufacturer?: 'minut' | 'noiseaware' | undefined
-  /**
-   * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
-   */
-  page_cursor?: string | undefined
-  /**
-   * String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
-   */
-  search?: string | undefined
-  /**
-   * ID of the space for which you want to list devices.
-   */
-  space_id?: string | undefined
-  /**
-   * @deprecated Use `space_id`.
-   */
-  unstable_location_id?: string | undefined
-  /**
-   * Your own internal user ID for the user for which you want to list devices.
-   */
-  user_identifier_key?: string | undefined
 }
 
 /**

package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { NoiseThreshold } from 'lib/resources/noise-threshold.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -168,6 +169,12 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     parameters: NoiseSensorsNoiseThresholdsCreateParameters,
     options: NoiseSensorsNoiseThresholdsCreateOptions = {},
   ): NoiseSensorsNoiseThresholdsCreateRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/noise_sensors/noise_thresholds/create',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/create',
       method: 'POST',
@@ -184,10 +191,16 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     parameters: NoiseSensorsNoiseThresholdsDeleteParameters,
     options: NoiseSensorsNoiseThresholdsDeleteOptions = {},
   ): NoiseSensorsNoiseThresholdsDeleteRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/noise_sensors/noise_thresholds/delete',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/delete',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -200,10 +213,16 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     parameters: NoiseSensorsNoiseThresholdsGetParameters,
     options: NoiseSensorsNoiseThresholdsGetOptions = {},
   ): NoiseSensorsNoiseThresholdsGetRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/noise_sensors/noise_thresholds/get',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'noise_threshold',
       options,
     })
@@ -216,10 +235,16 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     parameters: NoiseSensorsNoiseThresholdsListParameters,
     options: NoiseSensorsNoiseThresholdsListOptions = {},
   ): NoiseSensorsNoiseThresholdsListRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/noise_sensors/noise_thresholds/list',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'noise_thresholds',
       options,
     })
@@ -232,6 +257,12 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
     parameters: NoiseSensorsNoiseThresholdsUpdateParameters,
     options: NoiseSensorsNoiseThresholdsUpdateOptions = {},
   ): NoiseSensorsNoiseThresholdsUpdateRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/noise_sensors/noise_thresholds/update',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/update',
       method: 'PUT',

package/src/lib/routes/noise-sensors/simulate/simulate.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
 import { SeamPaginator } from 'lib/seam-paginator.js'
@@ -164,6 +165,12 @@ export class SeamHttpNoiseSensorsSimulate {
     parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters,
     options: NoiseSensorsSimulateTriggerNoiseThresholdOptions = {},
   ): NoiseSensorsSimulateTriggerNoiseThresholdRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/noise_sensors/simulate/trigger_noise_threshold',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/simulate/trigger_noise_threshold',
       method: 'POST',

package/src/lib/routes/phones/phones.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { Phone } from 'lib/resources/phone.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -171,10 +172,12 @@ export class SeamHttpPhones {
     parameters: PhonesDeactivateParameters,
     options: PhonesDeactivateOptions = {},
   ): PhonesDeactivateRequest {
+    assertValidRequestParameters(parameters, '/phones/deactivate', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/phones/deactivate',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -187,10 +190,12 @@ export class SeamHttpPhones {
     parameters: PhonesGetParameters,
     options: PhonesGetOptions = {},
   ): PhonesGetRequest {
+    assertValidRequestParameters(parameters, '/phones/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/phones/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'phone',
       options,
     })
@@ -203,10 +208,12 @@ export class SeamHttpPhones {
     parameters?: PhonesListParameters,
     options: PhonesListOptions = {},
   ): PhonesListRequest {
+    assertValidRequestParameters(parameters, '/phones/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/phones/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'phones',
       options,
     })

package/src/lib/routes/phones/simulate/simulate.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { Phone } from 'lib/resources/phone.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -165,6 +166,12 @@ export class SeamHttpPhonesSimulate {
     parameters: PhonesSimulateCreateSandboxPhoneParameters,
     options: PhonesSimulateCreateSandboxPhoneOptions = {},
   ): PhonesSimulateCreateSandboxPhoneRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/phones/simulate/create_sandbox_phone',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/phones/simulate/create_sandbox_phone',
       method: 'POST',