@seamapi/http 2.0.0 → 2.2.0

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

@@ -162,6 +162,9 @@ export class SeamHttpSpaces {
     await clientSessions.get()
   }
 
+  /**
+   * Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
+   */
   addAcsEntrances(
     parameters: SpacesAddAcsEntrancesParameters,
     options: SpacesAddAcsEntrancesOptions = {},
@@ -175,6 +178,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Adds a [connected account](https://docs.seam.co/core-concepts/connected-accounts) to a specific space.
+   */
   addConnectedAccount(
     parameters: SpacesAddConnectedAccountParameters,
     options: SpacesAddConnectedAccountOptions = {},
@@ -188,6 +194,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Adds devices to a specific space.
+   */
   addDevices(
     parameters: SpacesAddDevicesParameters,
     options: SpacesAddDevicesOptions = {},
@@ -201,6 +210,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Creates a new space.
+   */
   create(
     parameters: SpacesCreateParameters,
     options: SpacesCreateOptions = {},
@@ -214,6 +226,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Deletes a space.
+   */
   delete(
     parameters: SpacesDeleteParameters,
     options: SpacesDeleteOptions = {},
@@ -227,6 +242,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Gets a space.
+   */
   get(
     parameters?: SpacesGetParameters,
     options: SpacesGetOptions = {},
@@ -240,6 +258,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Gets all related resources for one or more Spaces.
+   */
   getRelated(
     parameters?: SpacesGetRelatedParameters,
     options: SpacesGetRelatedOptions = {},
@@ -253,6 +274,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Returns a list of all spaces.
+   */
   list(
     parameters?: SpacesListParameters,
     options: SpacesListOptions = {},
@@ -266,6 +290,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Removes [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
+   */
   removeAcsEntrances(
     parameters: SpacesRemoveAcsEntrancesParameters,
     options: SpacesRemoveAcsEntrancesOptions = {},
@@ -279,6 +306,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Removes a [connected account](https://docs.seam.co/core-concepts/connected-accounts) from a specific space.
+   */
   removeConnectedAccount(
     parameters: SpacesRemoveConnectedAccountParameters,
     options: SpacesRemoveConnectedAccountOptions = {},
@@ -292,6 +322,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Removes devices from a specific space.
+   */
   removeDevices(
     parameters: SpacesRemoveDevicesParameters,
     options: SpacesRemoveDevicesOptions = {},
@@ -305,6 +338,9 @@ export class SeamHttpSpaces {
     })
   }
 
+  /**
+   * Updates an existing space.
+   */
   update(
     parameters?: SpacesUpdateParameters,
     options: SpacesUpdateOptions = {},
@@ -320,8 +356,14 @@ export class SeamHttpSpaces {
 }
 
 export type SpacesAddAcsEntrancesParameters = {
+  /**
+   * IDs of the entrances that you want to add to the space.
+   */
   acs_entrance_ids: Array<string>
 
+  /**
+   * ID of the space to which you want to add entrances.
+   */
   space_id: string
 }
 
@@ -335,8 +377,14 @@ export type SpacesAddAcsEntrancesRequest = SeamHttpRequest<void, undefined>
 export interface SpacesAddAcsEntrancesOptions {}
 
 export type SpacesAddConnectedAccountParameters = {
+  /**
+   * ID of the connected account that you want to add to the space.
+   */
   connected_account_id: string
 
+  /**
+   * ID of the space to which you want to add the connected account.
+   */
   space_id: string
 }
 
@@ -350,8 +398,14 @@ export type SpacesAddConnectedAccountRequest = SeamHttpRequest<void, undefined>
 export interface SpacesAddConnectedAccountOptions {}
 
 export type SpacesAddDevicesParameters = {
+  /**
+   * IDs of the devices that you want to add to the space.
+   */
   device_ids: Array<string>
 
+  /**
+   * ID of the space to which you want to add devices.
+   */
   space_id: string
 }
 
@@ -365,20 +419,53 @@ export type SpacesAddDevicesRequest = SeamHttpRequest<void, undefined>
 export interface SpacesAddDevicesOptions {}
 
 export type SpacesCreateParameters = {
+  /**
+   * IDs of the entrances that you want to add to the new space.
+   */
   acs_entrance_ids?: Array<string> | undefined
+  /**
+   * IDs of connected accounts to associate with the new space. Persisted on seam.location_third_party_account so the UI can show which provider account(s) a space came from.
+   */
   connected_account_ids?: Array<string> | undefined
+  /**
+   * Reservation/stay-related defaults for the space.
+   */
   customer_data?:
     | {
+        /**
+         * Postal address for the space.
+         */
         address?: string | undefined
+        /**
+         * Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
+         */
         default_checkin_time?: string | undefined
+        /**
+         * Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
+         */
         default_checkout_time?: string | undefined
+        /**
+         * IANA time zone for the space, e.g. America/Los_Angeles.
+         */
         time_zone?: string | undefined
       }
     | undefined
+  /**
+   * Customer key for which you want to create the space.
+   */
   customer_key?: string | undefined
+  /**
+   * IDs of the devices that you want to add to the new space.
+   */
   device_ids?: Array<string> | undefined
+  /**
+   * Name of the space that you want to create.
+   */
   name: string
 
+  /**
+   * Unique key for the space within the workspace.
+   */
   space_key?: string | undefined
 }
 
@@ -392,6 +479,9 @@ export type SpacesCreateRequest = SeamHttpRequest<SpacesCreateResponse, 'space'>
 export interface SpacesCreateOptions {}
 
 export type SpacesDeleteParameters = {
+  /**
+   * ID of the space that you want to delete.
+   */
   space_id: string
 }
 
@@ -405,7 +495,13 @@ export type SpacesDeleteRequest = SeamHttpRequest<void, undefined>
 export interface SpacesDeleteOptions {}
 
 export type SpacesGetParameters = {
+  /**
+   * ID of the space that you want to get.
+   */
   space_id?: string | undefined
+  /**
+   * Unique key of the space that you want to get.
+   */
   space_key?: string | undefined
 }
 
@@ -429,6 +525,7 @@ export type SpacesGetRelatedParameters = {
         | 'access_methods'
       >
     | undefined
+
   include?:
     | Array<
         | 'spaces'
@@ -439,7 +536,13 @@ export type SpacesGetRelatedParameters = {
         | 'access_methods'
       >
     | undefined
+  /**
+   * IDs of the spaces that you want to get along with their related resources.
+   */
   space_ids?: Array<string> | undefined
+  /**
+   * Keys of the spaces that you want to get along with their related resources.
+   */
   space_keys?: Array<string> | undefined
 }
 
@@ -465,10 +568,25 @@ export type SpacesGetRelatedRequest = SeamHttpRequest<
 export interface SpacesGetRelatedOptions {}
 
 export type SpacesListParameters = {
+  /**
+   * Customer key for which you want to list spaces.
+   */
   customer_key?: string | undefined
+  /**
+   * Maximum number of records to return per page.
+   */
   limit?: number | 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 spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.
+   */
   search?: string | undefined
+  /**
+   * Filter spaces by space_key.
+   */
   space_key?: string | undefined
 }
 
@@ -482,8 +600,14 @@ export type SpacesListRequest = SeamHttpRequest<SpacesListResponse, 'spaces'>
 export interface SpacesListOptions {}
 
 export type SpacesRemoveAcsEntrancesParameters = {
+  /**
+   * IDs of the entrances that you want to remove from the space.
+   */
   acs_entrance_ids: Array<string>
 
+  /**
+   * ID of the space from which you want to remove entrances.
+   */
   space_id: string
 }
 
@@ -497,8 +621,14 @@ export type SpacesRemoveAcsEntrancesRequest = SeamHttpRequest<void, undefined>
 export interface SpacesRemoveAcsEntrancesOptions {}
 
 export type SpacesRemoveConnectedAccountParameters = {
+  /**
+   * ID of the connected account that you want to remove from the space.
+   */
   connected_account_id: string
 
+  /**
+   * ID of the space from which you want to remove the connected account.
+   */
   space_id: string
 }
 
@@ -515,8 +645,14 @@ export type SpacesRemoveConnectedAccountRequest = SeamHttpRequest<
 export interface SpacesRemoveConnectedAccountOptions {}
 
 export type SpacesRemoveDevicesParameters = {
+  /**
+   * IDs of the devices that you want to remove from the space.
+   */
   device_ids: Array<string>
 
+  /**
+   * ID of the space from which you want to remove devices.
+   */
   space_id: string
 }
 
@@ -530,18 +666,48 @@ export type SpacesRemoveDevicesRequest = SeamHttpRequest<void, undefined>
 export interface SpacesRemoveDevicesOptions {}
 
 export type SpacesUpdateParameters = {
+  /**
+   * IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.
+   */
   acs_entrance_ids?: Array<string> | undefined
+  /**
+   * Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it.
+   */
   customer_data?:
     | {
+        /**
+         * Postal address for the space.
+         */
         address?: string | undefined
+        /**
+         * Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
+         */
         default_checkin_time?: string | undefined
+        /**
+         * Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
+         */
         default_checkout_time?: string | undefined
+        /**
+         * IANA time zone for the space, e.g. America/Los_Angeles.
+         */
         time_zone?: string | undefined
       }
     | undefined
+  /**
+   * IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.
+   */
   device_ids?: Array<string> | undefined
+  /**
+   * Name of the space.
+   */
   name?: string | undefined
+  /**
+   * ID of the space that you want to update.
+   */
   space_id?: string | undefined
+  /**
+   * Unique key of the space that you want to update.
+   */
   space_key?: string | undefined
 }
 

package/src/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.ts

@@ -165,6 +165,9 @@ export class SeamHttpThermostatsDailyPrograms {
     await clientSessions.get()
   }
 
+  /**
+   * Creates a new thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.
+   */
   create(
     parameters: ThermostatsDailyProgramsCreateParameters,
     options: ThermostatsDailyProgramsCreateOptions = {},
@@ -178,6 +181,9 @@ export class SeamHttpThermostatsDailyPrograms {
     })
   }
 
+  /**
+   * Deletes a thermostat daily program.
+   */
   delete(
     parameters: ThermostatsDailyProgramsDeleteParameters,
     options: ThermostatsDailyProgramsDeleteOptions = {},
@@ -191,6 +197,9 @@ export class SeamHttpThermostatsDailyPrograms {
     })
   }
 
+  /**
+   * Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.
+   */
   update(
     parameters: ThermostatsDailyProgramsUpdateParameters,
     options: ThermostatsDailyProgramsUpdateOptions = {},
@@ -206,12 +215,27 @@ export class SeamHttpThermostatsDailyPrograms {
 }
 
 export type ThermostatsDailyProgramsCreateParameters = {
+  /**
+   * ID of the thermostat device for which you want to create a daily program.
+   */
   device_id: string
 
+  /**
+   * Name of the thermostat daily program.
+   */
   name: string
 
+  /**
+   * Array of thermostat daily program periods.
+   */
   periods: Array<{
+    /**
+     * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
+     */
     climate_preset_key?: string | undefined
+    /**
+     * Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
     starts_at_time?: string | undefined
   }>
 }
@@ -231,6 +255,9 @@ export type ThermostatsDailyProgramsCreateRequest = SeamHttpRequest<
 export interface ThermostatsDailyProgramsCreateOptions {}
 
 export type ThermostatsDailyProgramsDeleteParameters = {
+  /**
+   * ID of the thermostat daily program that you want to delete.
+   */
   thermostat_daily_program_id: string
 }
 
@@ -247,13 +274,28 @@ export type ThermostatsDailyProgramsDeleteRequest = SeamHttpRequest<
 export interface ThermostatsDailyProgramsDeleteOptions {}
 
 export type ThermostatsDailyProgramsUpdateParameters = {
+  /**
+   * Name of the thermostat daily program that you want to update.
+   */
   name: string
 
+  /**
+   * Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.
+   */
   periods: Array<{
+    /**
+     * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
+     */
     climate_preset_key?: string | undefined
+    /**
+     * Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+     */
     starts_at_time?: string | undefined
   }>
 
+  /**
+   * ID of the thermostat daily program that you want to update.
+   */
   thermostat_daily_program_id: string
 }
 

package/src/lib/seam/connect/routes/thermostats/schedules/schedules.ts

@@ -161,6 +161,9 @@ export class SeamHttpThermostatsSchedules {
     await clientSessions.get()
   }
 
+  /**
+   * Creates a new [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+   */
   create(
     parameters: ThermostatsSchedulesCreateParameters,
     options: ThermostatsSchedulesCreateOptions = {},
@@ -174,6 +177,9 @@ export class SeamHttpThermostatsSchedules {
     })
   }
 
+  /**
+   * Deletes a [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+   */
   delete(
     parameters: ThermostatsSchedulesDeleteParameters,
     options: ThermostatsSchedulesDeleteOptions = {},
@@ -187,6 +193,9 @@ export class SeamHttpThermostatsSchedules {
     })
   }
 
+  /**
+   * Returns a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+   */
   get(
     parameters: ThermostatsSchedulesGetParameters,
     options: ThermostatsSchedulesGetOptions = {},
@@ -200,6 +209,9 @@ export class SeamHttpThermostatsSchedules {
     })
   }
 
+  /**
+   * Returns a list of all [thermostat schedules](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+   */
   list(
     parameters: ThermostatsSchedulesListParameters,
     options: ThermostatsSchedulesListOptions = {},
@@ -213,6 +225,9 @@ export class SeamHttpThermostatsSchedules {
     })
   }
 
+  /**
+   * Updates a specified [thermostat schedule](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
+   */
   update(
     parameters: ThermostatsSchedulesUpdateParameters,
     options: ThermostatsSchedulesUpdateOptions = {},
@@ -228,15 +243,36 @@ export class SeamHttpThermostatsSchedules {
 }
 
 export type ThermostatsSchedulesCreateParameters = {
+  /**
+   * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule.
+   */
   climate_preset_key: string
 
+  /**
+   * ID of the thermostat device for which you want to create a schedule.
+   */
   device_id: string
 
+  /**
+   * Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   ends_at: string
 
+  /**
+   * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+   */
   is_override_allowed?: boolean | undefined
+  /**
+   * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+   */
   max_override_period_minutes?: number | undefined
+  /**
+   * Name of the thermostat schedule.
+   */
   name?: string | undefined
+  /**
+   * Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at: string
 }
 
@@ -255,6 +291,9 @@ export type ThermostatsSchedulesCreateRequest = SeamHttpRequest<
 export interface ThermostatsSchedulesCreateOptions {}
 
 export type ThermostatsSchedulesDeleteParameters = {
+  /**
+   * ID of the thermostat schedule that you want to delete.
+   */
   thermostat_schedule_id: string
 }
 
@@ -268,6 +307,9 @@ export type ThermostatsSchedulesDeleteRequest = SeamHttpRequest<void, undefined>
 export interface ThermostatsSchedulesDeleteOptions {}
 
 export type ThermostatsSchedulesGetParameters = {
+  /**
+   * ID of the thermostat schedule that you want to get.
+   */
   thermostat_schedule_id: string
 }
 
@@ -286,8 +328,14 @@ export type ThermostatsSchedulesGetRequest = SeamHttpRequest<
 export interface ThermostatsSchedulesGetOptions {}
 
 export type ThermostatsSchedulesListParameters = {
+  /**
+   * ID of the thermostat device for which you want to list schedules.
+   */
   device_id: string
 
+  /**
+   * User identifier key by which to filter the list of returned thermostat schedules.
+   */
   user_identifier_key?: string | undefined
 }
 
@@ -306,12 +354,33 @@ export type ThermostatsSchedulesListRequest = SeamHttpRequest<
 export interface ThermostatsSchedulesListOptions {}
 
 export type ThermostatsSchedulesUpdateParameters = {
+  /**
+   * Key of the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.
+   */
   climate_preset_key?: string | undefined
+  /**
+   * Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   ends_at?: string | undefined
+  /**
+   * Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+   */
   is_override_allowed?: boolean | undefined
+  /**
+   * Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+   */
   max_override_period_minutes?: number | undefined
+  /**
+   * Name of the thermostat schedule.
+   */
   name?: string | undefined
+  /**
+   * Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
+   */
   starts_at?: string | undefined
+  /**
+   * ID of the thermostat schedule that you want to update.
+   */
   thermostat_schedule_id: string
 }
 

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

@@ -160,6 +160,9 @@ export class SeamHttpThermostatsSimulate {
     await clientSessions.get()
   }
 
+  /**
+   * Simulates having adjusted the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+   */
   hvacModeAdjusted(
     parameters: ThermostatsSimulateHvacModeAdjustedParameters,
     options: ThermostatsSimulateHvacModeAdjustedOptions = {},
@@ -173,6 +176,9 @@ export class SeamHttpThermostatsSimulate {
     })
   }
 
+  /**
+   * Simulates a [thermostat](https://docs.seam.co/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
+   */
   temperatureReached(
     parameters: ThermostatsSimulateTemperatureReachedParameters,
     options: ThermostatsSimulateTemperatureReachedOptions = {},
@@ -188,13 +194,31 @@ export class SeamHttpThermostatsSimulate {
 }
 
 export type ThermostatsSimulateHvacModeAdjustedParameters = {
+  /**
+   * ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.
+   */
   device_id: string
 
+  /**
+   * HVAC mode that you want to simulate.
+   */
   hvac_mode: 'off' | 'cool' | 'heat' | 'heat_cool'
 
+  /**
+   * Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.
+   */
   cooling_set_point_celsius?: number | undefined
+  /**
+   * Cooling [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.
+   */
   cooling_set_point_fahrenheit?: number | undefined
+  /**
+   * Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.
+   */
   heating_set_point_celsius?: number | undefined
+  /**
+   * Heating [set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.
+   */
   heating_set_point_fahrenheit?: number | undefined
 }
 
@@ -211,9 +235,18 @@ export type ThermostatsSimulateHvacModeAdjustedRequest = SeamHttpRequest<
 export interface ThermostatsSimulateHvacModeAdjustedOptions {}
 
 export type ThermostatsSimulateTemperatureReachedParameters = {
+  /**
+   * ID of the thermostat device that you want to simulate reaching a specified temperature.
+   */
   device_id: string
 
+  /**
+   * Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.
+   */
   temperature_celsius?: number | undefined
+  /**
+   * Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.
+   */
   temperature_fahrenheit?: number | undefined
 }