@seamapi/http 1.37.0 → 1.38.1

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

@@ -169,9 +169,9 @@ export class SeamHttpLocksSimulate {
   }
 
   keypadCodeEntry(
-    body?: LocksSimulateKeypadCodeEntryBody,
+    parameters?: LocksSimulateKeypadCodeEntryParameters,
     options: LocksSimulateKeypadCodeEntryOptions = {},
-  ): SeamHttpRequest<LocksSimulateKeypadCodeEntryResponse, 'action_attempt'> {
+  ): LocksSimulateKeypadCodeEntryRequest {
     if (!this.defaults.isUndocumentedApiEnabled) {
       throw new Error(
         'Cannot use undocumented API without isUndocumentedApiEnabled',
@@ -180,19 +180,16 @@ export class SeamHttpLocksSimulate {
     return new SeamHttpRequest(this, {
       pathname: '/locks/simulate/keypad_code_entry',
       method: 'POST',
-      body,
+      body: parameters,
       responseKey: 'action_attempt',
       options,
     })
   }
 
   manualLockViaKeypad(
-    body?: LocksSimulateManualLockViaKeypadBody,
+    parameters?: LocksSimulateManualLockViaKeypadParameters,
     options: LocksSimulateManualLockViaKeypadOptions = {},
-  ): SeamHttpRequest<
-    LocksSimulateManualLockViaKeypadResponse,
-    'action_attempt'
-  > {
+  ): LocksSimulateManualLockViaKeypadRequest {
     if (!this.defaults.isUndocumentedApiEnabled) {
       throw new Error(
         'Cannot use undocumented API without isUndocumentedApiEnabled',
@@ -201,32 +198,60 @@ export class SeamHttpLocksSimulate {
     return new SeamHttpRequest(this, {
       pathname: '/locks/simulate/manual_lock_via_keypad',
       method: 'POST',
-      body,
+      body: parameters,
       responseKey: 'action_attempt',
       options,
     })
   }
 }
 
-export type LocksSimulateKeypadCodeEntryBody =
+export type LocksSimulateKeypadCodeEntryParameters =
   RouteRequestBody<'/locks/simulate/keypad_code_entry'>
 
+/**
+ * @deprecated Use LocksSimulateKeypadCodeEntryParameters instead.
+ */
+export type LocksSimulateKeypadCodeEntryBody =
+  LocksSimulateKeypadCodeEntryParameters
+
+/**
+ * @deprecated Use LocksSimulateKeypadCodeEntryRequest instead.
+ */
 export type LocksSimulateKeypadCodeEntryResponse = SetNonNullable<
   Required<RouteResponse<'/locks/simulate/keypad_code_entry'>>
 >
 
+export type LocksSimulateKeypadCodeEntryRequest = SeamHttpRequest<
+  LocksSimulateKeypadCodeEntryResponse,
+  'action_attempt'
+>
+
 export type LocksSimulateKeypadCodeEntryOptions = Pick<
   SeamHttpRequestOptions,
   'waitForActionAttempt'
 >
 
-export type LocksSimulateManualLockViaKeypadBody =
+export type LocksSimulateManualLockViaKeypadParameters =
   RouteRequestBody<'/locks/simulate/manual_lock_via_keypad'>
 
+/**
+ * @deprecated Use LocksSimulateManualLockViaKeypadParameters instead.
+ */
+export type LocksSimulateManualLockViaKeypadBody =
+  LocksSimulateManualLockViaKeypadParameters
+
+/**
+ * @deprecated Use LocksSimulateManualLockViaKeypadRequest instead.
+ */
 export type LocksSimulateManualLockViaKeypadResponse = SetNonNullable<
   Required<RouteResponse<'/locks/simulate/manual_lock_via_keypad'>>
 >
 
+export type LocksSimulateManualLockViaKeypadRequest = SeamHttpRequest<
+  LocksSimulateManualLockViaKeypadResponse,
+  'action_attempt'
+>
+
 export type LocksSimulateManualLockViaKeypadOptions = Pick<
   SeamHttpRequestOptions,
   'waitForActionAttempt'

package/src/lib/seam/connect/routes/networks/networks.ts

@@ -169,8 +169,9 @@ export class SeamHttpNetworks {
   }
 
   get(
-    params?: NetworksGetParams,
-  ): SeamHttpRequest<NetworksGetResponse, 'network'> {
+    parameters?: NetworksGetParameters,
+    options: NetworksGetOptions = {},
+  ): NetworksGetRequest {
     if (!this.defaults.isUndocumentedApiEnabled) {
       throw new Error(
         'Cannot use undocumented API without isUndocumentedApiEnabled',
@@ -179,14 +180,16 @@ export class SeamHttpNetworks {
     return new SeamHttpRequest(this, {
       pathname: '/networks/get',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'network',
+      options,
     })
   }
 
   list(
-    params?: NetworksListParams,
-  ): SeamHttpRequest<NetworksListResponse, 'networks'> {
+    parameters?: NetworksListParameters,
+    options: NetworksListOptions = {},
+  ): NetworksListRequest {
     if (!this.defaults.isUndocumentedApiEnabled) {
       throw new Error(
         'Cannot use undocumented API without isUndocumentedApiEnabled',
@@ -195,24 +198,48 @@ export class SeamHttpNetworks {
     return new SeamHttpRequest(this, {
       pathname: '/networks/list',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'networks',
+      options,
     })
   }
 }
 
-export type NetworksGetParams = RouteRequestBody<'/networks/get'>
+export type NetworksGetParameters = RouteRequestBody<'/networks/get'>
 
+/**
+ * @deprecated Use NetworksGetParameters instead.
+ */
+export type NetworksGetParams = NetworksGetParameters
+
+/**
+ * @deprecated Use NetworksGetRequest instead.
+ */
 export type NetworksGetResponse = SetNonNullable<
   Required<RouteResponse<'/networks/get'>>
 >
 
-export type NetworksGetOptions = never
+export type NetworksGetRequest = SeamHttpRequest<NetworksGetResponse, 'network'>
 
-export type NetworksListParams = RouteRequestBody<'/networks/list'>
+export type NetworksGetOptions = Record<string, never>
 
+export type NetworksListParameters = RouteRequestBody<'/networks/list'>
+
+/**
+ * @deprecated Use NetworksListParameters instead.
+ */
+export type NetworksListParams = NetworksListParameters
+
+/**
+ * @deprecated Use NetworksListRequest instead.
+ */
 export type NetworksListResponse = SetNonNullable<
   Required<RouteResponse<'/networks/list'>>
 >
 
-export type NetworksListOptions = never
+export type NetworksListRequest = SeamHttpRequest<
+  NetworksListResponse,
+  'networks'
+>
+
+export type NetworksListOptions = Record<string, never>

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

@@ -178,21 +178,36 @@ export class SeamHttpNoiseSensors {
   }
 
   list(
-    params?: NoiseSensorsListParams,
-  ): SeamHttpRequest<NoiseSensorsListResponse, 'devices'> {
+    parameters?: NoiseSensorsListParameters,
+    options: NoiseSensorsListOptions = {},
+  ): NoiseSensorsListRequest {
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/list',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'devices',
+      options,
     })
   }
 }
 
-export type NoiseSensorsListParams = RouteRequestBody<'/noise_sensors/list'>
+export type NoiseSensorsListParameters = RouteRequestBody<'/noise_sensors/list'>
 
+/**
+ * @deprecated Use NoiseSensorsListParameters instead.
+ */
+export type NoiseSensorsListParams = NoiseSensorsListParameters
+
+/**
+ * @deprecated Use NoiseSensorsListRequest instead.
+ */
 export type NoiseSensorsListResponse = SetNonNullable<
   Required<RouteResponse<'/noise_sensors/list'>>
 >
 
-export type NoiseSensorsListOptions = never
+export type NoiseSensorsListRequest = SeamHttpRequest<
+  NoiseSensorsListResponse,
+  'devices'
+>
+
+export type NoiseSensorsListOptions = Record<string, never>

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

@@ -167,111 +167,182 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
   }
 
   create(
-    body?: NoiseSensorsNoiseThresholdsCreateBody,
-  ): SeamHttpRequest<
-    NoiseSensorsNoiseThresholdsCreateResponse,
-    'noise_threshold'
-  > {
+    parameters?: NoiseSensorsNoiseThresholdsCreateParameters,
+    options: NoiseSensorsNoiseThresholdsCreateOptions = {},
+  ): NoiseSensorsNoiseThresholdsCreateRequest {
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/create',
       method: 'POST',
-      body,
+      body: parameters,
       responseKey: 'noise_threshold',
+      options,
     })
   }
 
   delete(
-    params?: NoiseSensorsNoiseThresholdsDeleteParams,
-  ): SeamHttpRequest<void, undefined> {
+    parameters?: NoiseSensorsNoiseThresholdsDeleteParameters,
+    options: NoiseSensorsNoiseThresholdsDeleteOptions = {},
+  ): NoiseSensorsNoiseThresholdsDeleteRequest {
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/delete',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: undefined,
+      options,
     })
   }
 
   get(
-    params?: NoiseSensorsNoiseThresholdsGetParams,
-  ): SeamHttpRequest<
-    NoiseSensorsNoiseThresholdsGetResponse,
-    'noise_threshold'
-  > {
+    parameters?: NoiseSensorsNoiseThresholdsGetParameters,
+    options: NoiseSensorsNoiseThresholdsGetOptions = {},
+  ): NoiseSensorsNoiseThresholdsGetRequest {
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/get',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'noise_threshold',
+      options,
     })
   }
 
   list(
-    params?: NoiseSensorsNoiseThresholdsListParams,
-  ): SeamHttpRequest<
-    NoiseSensorsNoiseThresholdsListResponse,
-    'noise_thresholds'
-  > {
+    parameters?: NoiseSensorsNoiseThresholdsListParameters,
+    options: NoiseSensorsNoiseThresholdsListOptions = {},
+  ): NoiseSensorsNoiseThresholdsListRequest {
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/list',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'noise_thresholds',
+      options,
     })
   }
 
   update(
-    body?: NoiseSensorsNoiseThresholdsUpdateBody,
-  ): SeamHttpRequest<void, undefined> {
+    parameters?: NoiseSensorsNoiseThresholdsUpdateParameters,
+    options: NoiseSensorsNoiseThresholdsUpdateOptions = {},
+  ): NoiseSensorsNoiseThresholdsUpdateRequest {
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/noise_thresholds/update',
       method: 'PUT',
-      body,
+      body: parameters,
       responseKey: undefined,
+      options,
     })
   }
 }
 
-export type NoiseSensorsNoiseThresholdsCreateBody =
+export type NoiseSensorsNoiseThresholdsCreateParameters =
   RouteRequestBody<'/noise_sensors/noise_thresholds/create'>
 
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsCreateParameters instead.
+ */
+export type NoiseSensorsNoiseThresholdsCreateBody =
+  NoiseSensorsNoiseThresholdsCreateParameters
+
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsCreateRequest instead.
+ */
 export type NoiseSensorsNoiseThresholdsCreateResponse = SetNonNullable<
   Required<RouteResponse<'/noise_sensors/noise_thresholds/create'>>
 >
 
-export type NoiseSensorsNoiseThresholdsCreateOptions = never
+export type NoiseSensorsNoiseThresholdsCreateRequest = SeamHttpRequest<
+  NoiseSensorsNoiseThresholdsCreateResponse,
+  'noise_threshold'
+>
 
-export type NoiseSensorsNoiseThresholdsDeleteParams =
+export type NoiseSensorsNoiseThresholdsCreateOptions = Record<string, never>
+
+export type NoiseSensorsNoiseThresholdsDeleteParameters =
   RouteRequestBody<'/noise_sensors/noise_thresholds/delete'>
 
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsDeleteParameters instead.
+ */
+export type NoiseSensorsNoiseThresholdsDeleteParams =
+  NoiseSensorsNoiseThresholdsDeleteParameters
+
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsDeleteRequest instead.
+ */
 export type NoiseSensorsNoiseThresholdsDeleteResponse = SetNonNullable<
   Required<RouteResponse<'/noise_sensors/noise_thresholds/delete'>>
 >
 
-export type NoiseSensorsNoiseThresholdsDeleteOptions = never
+export type NoiseSensorsNoiseThresholdsDeleteRequest = SeamHttpRequest<
+  void,
+  undefined
+>
 
-export type NoiseSensorsNoiseThresholdsGetParams =
+export type NoiseSensorsNoiseThresholdsDeleteOptions = Record<string, never>
+
+export type NoiseSensorsNoiseThresholdsGetParameters =
   RouteRequestBody<'/noise_sensors/noise_thresholds/get'>
 
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsGetParameters instead.
+ */
+export type NoiseSensorsNoiseThresholdsGetParams =
+  NoiseSensorsNoiseThresholdsGetParameters
+
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsGetRequest instead.
+ */
 export type NoiseSensorsNoiseThresholdsGetResponse = SetNonNullable<
   Required<RouteResponse<'/noise_sensors/noise_thresholds/get'>>
 >
 
-export type NoiseSensorsNoiseThresholdsGetOptions = never
+export type NoiseSensorsNoiseThresholdsGetRequest = SeamHttpRequest<
+  NoiseSensorsNoiseThresholdsGetResponse,
+  'noise_threshold'
+>
+
+export type NoiseSensorsNoiseThresholdsGetOptions = Record<string, never>
 
-export type NoiseSensorsNoiseThresholdsListParams =
+export type NoiseSensorsNoiseThresholdsListParameters =
   RouteRequestBody<'/noise_sensors/noise_thresholds/list'>
 
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsListParameters instead.
+ */
+export type NoiseSensorsNoiseThresholdsListParams =
+  NoiseSensorsNoiseThresholdsListParameters
+
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsListRequest instead.
+ */
 export type NoiseSensorsNoiseThresholdsListResponse = SetNonNullable<
   Required<RouteResponse<'/noise_sensors/noise_thresholds/list'>>
 >
 
-export type NoiseSensorsNoiseThresholdsListOptions = never
+export type NoiseSensorsNoiseThresholdsListRequest = SeamHttpRequest<
+  NoiseSensorsNoiseThresholdsListResponse,
+  'noise_thresholds'
+>
 
-export type NoiseSensorsNoiseThresholdsUpdateBody =
+export type NoiseSensorsNoiseThresholdsListOptions = Record<string, never>
+
+export type NoiseSensorsNoiseThresholdsUpdateParameters =
   RouteRequestBody<'/noise_sensors/noise_thresholds/update'>
 
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsUpdateParameters instead.
+ */
+export type NoiseSensorsNoiseThresholdsUpdateBody =
+  NoiseSensorsNoiseThresholdsUpdateParameters
+
+/**
+ * @deprecated Use NoiseSensorsNoiseThresholdsUpdateRequest instead.
+ */
 export type NoiseSensorsNoiseThresholdsUpdateResponse = SetNonNullable<
   Required<RouteResponse<'/noise_sensors/noise_thresholds/update'>>
 >
 
-export type NoiseSensorsNoiseThresholdsUpdateOptions = never
+export type NoiseSensorsNoiseThresholdsUpdateRequest = SeamHttpRequest<
+  void,
+  undefined
+>
+
+export type NoiseSensorsNoiseThresholdsUpdateOptions = Record<string, never>

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

@@ -164,22 +164,41 @@ export class SeamHttpNoiseSensorsSimulate {
   }
 
   triggerNoiseThreshold(
-    body?: NoiseSensorsSimulateTriggerNoiseThresholdBody,
-  ): SeamHttpRequest<void, undefined> {
+    parameters?: NoiseSensorsSimulateTriggerNoiseThresholdParameters,
+    options: NoiseSensorsSimulateTriggerNoiseThresholdOptions = {},
+  ): NoiseSensorsSimulateTriggerNoiseThresholdRequest {
     return new SeamHttpRequest(this, {
       pathname: '/noise_sensors/simulate/trigger_noise_threshold',
       method: 'POST',
-      body,
+      body: parameters,
       responseKey: undefined,
+      options,
     })
   }
 }
 
-export type NoiseSensorsSimulateTriggerNoiseThresholdBody =
+export type NoiseSensorsSimulateTriggerNoiseThresholdParameters =
   RouteRequestBody<'/noise_sensors/simulate/trigger_noise_threshold'>
 
+/**
+ * @deprecated Use NoiseSensorsSimulateTriggerNoiseThresholdParameters instead.
+ */
+export type NoiseSensorsSimulateTriggerNoiseThresholdBody =
+  NoiseSensorsSimulateTriggerNoiseThresholdParameters
+
+/**
+ * @deprecated Use NoiseSensorsSimulateTriggerNoiseThresholdRequest instead.
+ */
 export type NoiseSensorsSimulateTriggerNoiseThresholdResponse = SetNonNullable<
   Required<RouteResponse<'/noise_sensors/simulate/trigger_noise_threshold'>>
 >
 
-export type NoiseSensorsSimulateTriggerNoiseThresholdOptions = never
+export type NoiseSensorsSimulateTriggerNoiseThresholdRequest = SeamHttpRequest<
+  void,
+  undefined
+>
+
+export type NoiseSensorsSimulateTriggerNoiseThresholdOptions = Record<
+  string,
+  never
+>

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

@@ -170,57 +170,95 @@ export class SeamHttpPhones {
   }
 
   deactivate(
-    params?: PhonesDeactivateParams,
-  ): SeamHttpRequest<void, undefined> {
+    parameters?: PhonesDeactivateParameters,
+    options: PhonesDeactivateOptions = {},
+  ): PhonesDeactivateRequest {
     return new SeamHttpRequest(this, {
       pathname: '/phones/deactivate',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: undefined,
+      options,
     })
   }
 
-  get(params?: PhonesGetParams): SeamHttpRequest<PhonesGetResponse, 'phone'> {
+  get(
+    parameters?: PhonesGetParameters,
+    options: PhonesGetOptions = {},
+  ): PhonesGetRequest {
     return new SeamHttpRequest(this, {
       pathname: '/phones/get',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'phone',
+      options,
     })
   }
 
   list(
-    params?: PhonesListParams,
-  ): SeamHttpRequest<PhonesListResponse, 'phones'> {
+    parameters?: PhonesListParameters,
+    options: PhonesListOptions = {},
+  ): PhonesListRequest {
     return new SeamHttpRequest(this, {
       pathname: '/phones/list',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'phones',
+      options,
     })
   }
 }
 
-export type PhonesDeactivateParams = RouteRequestBody<'/phones/deactivate'>
+export type PhonesDeactivateParameters = RouteRequestBody<'/phones/deactivate'>
 
+/**
+ * @deprecated Use PhonesDeactivateParameters instead.
+ */
+export type PhonesDeactivateParams = PhonesDeactivateParameters
+
+/**
+ * @deprecated Use PhonesDeactivateRequest instead.
+ */
 export type PhonesDeactivateResponse = SetNonNullable<
   Required<RouteResponse<'/phones/deactivate'>>
 >
 
-export type PhonesDeactivateOptions = never
+export type PhonesDeactivateRequest = SeamHttpRequest<void, undefined>
 
-export type PhonesGetParams = RouteRequestBody<'/phones/get'>
+export type PhonesDeactivateOptions = Record<string, never>
+
+export type PhonesGetParameters = RouteRequestBody<'/phones/get'>
+
+/**
+ * @deprecated Use PhonesGetParameters instead.
+ */
+export type PhonesGetParams = PhonesGetParameters
 
+/**
+ * @deprecated Use PhonesGetRequest instead.
+ */
 export type PhonesGetResponse = SetNonNullable<
   Required<RouteResponse<'/phones/get'>>
 >
 
-export type PhonesGetOptions = never
+export type PhonesGetRequest = SeamHttpRequest<PhonesGetResponse, 'phone'>
+
+export type PhonesGetOptions = Record<string, never>
+
+export type PhonesListParameters = RouteRequestBody<'/phones/list'>
 
-export type PhonesListParams = RouteRequestBody<'/phones/list'>
+/**
+ * @deprecated Use PhonesListParameters instead.
+ */
+export type PhonesListParams = PhonesListParameters
 
+/**
+ * @deprecated Use PhonesListRequest instead.
+ */
 export type PhonesListResponse = SetNonNullable<
   Required<RouteResponse<'/phones/list'>>
 >
 
-export type PhonesListOptions = never
+export type PhonesListRequest = SeamHttpRequest<PhonesListResponse, 'phones'>
+
+export type PhonesListOptions = Record<string, never>

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

@@ -164,22 +164,38 @@ export class SeamHttpPhonesSimulate {
   }
 
   createSandboxPhone(
-    params?: PhonesSimulateCreateSandboxPhoneParams,
-  ): SeamHttpRequest<PhonesSimulateCreateSandboxPhoneResponse, 'phone'> {
+    parameters?: PhonesSimulateCreateSandboxPhoneParameters,
+    options: PhonesSimulateCreateSandboxPhoneOptions = {},
+  ): PhonesSimulateCreateSandboxPhoneRequest {
     return new SeamHttpRequest(this, {
       pathname: '/phones/simulate/create_sandbox_phone',
       method: 'POST',
-      body: params,
+      body: parameters,
       responseKey: 'phone',
+      options,
     })
   }
 }
 
-export type PhonesSimulateCreateSandboxPhoneParams =
+export type PhonesSimulateCreateSandboxPhoneParameters =
   RouteRequestBody<'/phones/simulate/create_sandbox_phone'>
 
+/**
+ * @deprecated Use PhonesSimulateCreateSandboxPhoneParameters instead.
+ */
+export type PhonesSimulateCreateSandboxPhoneParams =
+  PhonesSimulateCreateSandboxPhoneParameters
+
+/**
+ * @deprecated Use PhonesSimulateCreateSandboxPhoneRequest instead.
+ */
 export type PhonesSimulateCreateSandboxPhoneResponse = SetNonNullable<
   Required<RouteResponse<'/phones/simulate/create_sandbox_phone'>>
 >
 
-export type PhonesSimulateCreateSandboxPhoneOptions = never
+export type PhonesSimulateCreateSandboxPhoneRequest = SeamHttpRequest<
+  PhonesSimulateCreateSandboxPhoneResponse,
+  'phone'
+>
+
+export type PhonesSimulateCreateSandboxPhoneOptions = Record<string, never>