seam 2.132.0 → 2.133.0

data/lib/seam/routes/locks.rb

@@ -14,6 +14,11 @@ module Seam
         @simulate ||= Seam::Clients::LocksSimulate.new(client: @client, defaults: @defaults)
       end
 
+      # Configures the auto-lock setting for a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+      # @param auto_lock_enabled Whether to enable or disable auto-lock.
+      # @param device_id ID of the lock for which you want to configure the auto-lock.
+      # @param auto_lock_delay_seconds Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60.
+      # @return [Seam::Resources::ActionAttempt] OK
       def configure_auto_lock(auto_lock_enabled:, device_id:, auto_lock_delay_seconds: nil, wait_for_action_attempt: nil)
         res = @client.post("/locks/configure_auto_lock", {auto_lock_enabled: auto_lock_enabled, device_id: device_id, auto_lock_delay_seconds: auto_lock_delay_seconds}.compact)
 
@@ -22,18 +27,45 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Returns a specified [lock](https://docs.seam.co/low-level-apis/smart-locks).
+      # @param device_id ID of the lock that you want to get.
+      # @param name Name of the lock that you want to get.
+      # @return [Seam::Resources::Device] OK
+      # @deprecated Use `/devices/get` instead.
       def get(device_id: nil, name: nil)
         res = @client.post("/locks/get", {device_id: device_id, name: name}.compact)
 
         Seam::Resources::Device.load_from_response(res.body["device"])
       end
 
+      # Returns a list of all [locks](https://docs.seam.co/low-level-apis/smart-locks).
+      # @param connect_webview_id ID of the Connect Webview for which you want to list devices.
+      # @param connected_account_id ID of the connected account for which you want to list devices.
+      # @param connected_account_ids Array of IDs of the connected accounts for which you want to list devices.
+      # @param created_before Timestamp by which to limit returned devices. Returns devices created before this timestamp.
+      # @param custom_metadata_has 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.
+      # @param customer_key Customer key for which you want to list devices.
+      # @param device_ids Array of device IDs for which you want to list devices.
+      # @param device_type Device type of the locks that you want to list.
+      # @param device_types Device types of the locks that you want to list.
+      # @param limit Numerical limit on the number of devices to return.
+      # @param manufacturer Manufacturer of the locks that you want to list.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search 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`.
+      # @param space_id ID of the space for which you want to list devices.
+      # @param unstable_location_id
+      # @deprecated unstable_location_id: Use `space_id`.
+      # @param user_identifier_key Your own internal user ID for the user for which you want to list devices.
+      # @return [Seam::Resources::Device] OK
       def list(connect_webview_id: nil, connected_account_id: nil, connected_account_ids: nil, created_before: nil, custom_metadata_has: nil, customer_key: nil, device_ids: nil, device_type: nil, device_types: nil, limit: nil, manufacturer: nil, page_cursor: nil, search: nil, space_id: nil, unstable_location_id: nil, user_identifier_key: nil)
         res = @client.post("/locks/list", {connect_webview_id: connect_webview_id, connected_account_id: connected_account_id, connected_account_ids: connected_account_ids, created_before: created_before, custom_metadata_has: custom_metadata_has, customer_key: customer_key, device_ids: device_ids, device_type: device_type, device_types: device_types, limit: limit, manufacturer: manufacturer, page_cursor: page_cursor, search: search, space_id: space_id, unstable_location_id: unstable_location_id, user_identifier_key: user_identifier_key}.compact)
 
         Seam::Resources::Device.load_from_response(res.body["devices"])
       end
 
+      # Locks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock).
+      # @param device_id ID of the lock that you want to lock.
+      # @return [Seam::Resources::ActionAttempt] OK
       def lock_door(device_id:, wait_for_action_attempt: nil)
         res = @client.post("/locks/lock_door", {device_id: device_id}.compact)
 
@@ -42,6 +74,9 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Unlocks a [lock](https://docs.seam.co/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/low-level-apis/smart-locks/lock-and-unlock).
+      # @param device_id ID of the lock that you want to unlock.
+      # @return [Seam::Resources::ActionAttempt] OK
       def unlock_door(device_id:, wait_for_action_attempt: nil)
         res = @client.post("/locks/unlock_door", {device_id: device_id}.compact)
 

data/lib/seam/routes/locks_simulate.rb

@@ -10,6 +10,10 @@ module Seam
         @defaults = defaults
       end
 
+      # Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param code Code that you want to simulate entering on a keypad.
+      # @param device_id ID of the device for which you want to simulate a keypad code entry.
+      # @return [Seam::Resources::ActionAttempt] OK
       def keypad_code_entry(code:, device_id:, wait_for_action_attempt: nil)
         res = @client.post("/locks/simulate/keypad_code_entry", {code: code, device_id: device_id}.compact)
 
@@ -18,6 +22,9 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param device_id ID of the device for which you want to simulate a manual lock action using a keypad.
+      # @return [Seam::Resources::ActionAttempt] OK
       def manual_lock_via_keypad(device_id:, wait_for_action_attempt: nil)
         res = @client.post("/locks/simulate/manual_lock_via_keypad", {device_id: device_id}.compact)
 

data/lib/seam/routes/noise_sensors.rb

@@ -16,6 +16,25 @@ module Seam
         @simulate ||= Seam::Clients::NoiseSensorsSimulate.new(client: @client, defaults: @defaults)
       end
 
+      # Returns a list of all [noise sensors](https://docs.seam.co/capability-guides/noise-sensors).
+      # @param connect_webview_id ID of the Connect Webview for which you want to list devices.
+      # @param connected_account_id ID of the connected account for which you want to list devices.
+      # @param connected_account_ids Array of IDs of the connected accounts for which you want to list devices.
+      # @param created_before Timestamp by which to limit returned devices. Returns devices created before this timestamp.
+      # @param custom_metadata_has 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.
+      # @param customer_key Customer key for which you want to list devices.
+      # @param device_ids Array of device IDs for which you want to list devices.
+      # @param device_type Device type of the noise sensors that you want to list.
+      # @param device_types Device types of the noise sensors that you want to list.
+      # @param limit Numerical limit on the number of devices to return.
+      # @param manufacturer Manufacturers of the noise sensors that you want to list.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search 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`.
+      # @param space_id ID of the space for which you want to list devices.
+      # @param unstable_location_id
+      # @deprecated unstable_location_id: Use `space_id`.
+      # @param user_identifier_key Your own internal user ID for the user for which you want to list devices.
+      # @return [Seam::Resources::Device] OK
       def list(connect_webview_id: nil, connected_account_id: nil, connected_account_ids: nil, created_before: nil, custom_metadata_has: nil, customer_key: nil, device_ids: nil, device_type: nil, device_types: nil, limit: nil, manufacturer: nil, page_cursor: nil, search: nil, space_id: nil, unstable_location_id: nil, user_identifier_key: nil)
         res = @client.post("/noise_sensors/list", {connect_webview_id: connect_webview_id, connected_account_id: connected_account_id, connected_account_ids: connected_account_ids, created_before: created_before, custom_metadata_has: custom_metadata_has, customer_key: customer_key, device_ids: device_ids, device_type: device_type, device_types: device_types, limit: limit, manufacturer: manufacturer, page_cursor: page_cursor, search: search, space_id: space_id, unstable_location_id: unstable_location_id, user_identifier_key: user_identifier_key}.compact)
 

data/lib/seam/routes/noise_sensors_noise_thresholds.rb

@@ -8,30 +8,57 @@ module Seam
         @defaults = defaults
       end
 
+      # Creates a new [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
+      # @param device_id ID of the device for which you want to create a noise threshold.
+      # @param ends_daily_at Time at which the new noise threshold should become inactive daily.
+      # @param starts_daily_at Time at which the new noise threshold should become active daily.
+      # @param name Name of the new noise threshold.
+      # @param noise_threshold_decibels Noise level in decibels for the new noise threshold.
+      # @param noise_threshold_nrs Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors).
+      # @return [Seam::Resources::NoiseThreshold] OK
       def create(device_id:, ends_daily_at:, starts_daily_at:, name: nil, noise_threshold_decibels: nil, noise_threshold_nrs: nil)
         res = @client.post("/noise_sensors/noise_thresholds/create", {device_id: device_id, ends_daily_at: ends_daily_at, starts_daily_at: starts_daily_at, name: name, noise_threshold_decibels: noise_threshold_decibels, noise_threshold_nrs: noise_threshold_nrs}.compact)
 
         Seam::Resources::NoiseThreshold.load_from_response(res.body["noise_threshold"])
       end
 
+      # Deletes a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+      # @param device_id ID of the device that contains the noise threshold that you want to delete.
+      # @param noise_threshold_id ID of the noise threshold that you want to delete.
+      # @return [nil] OK
       def delete(device_id:, noise_threshold_id:)
         @client.post("/noise_sensors/noise_thresholds/delete", {device_id: device_id, noise_threshold_id: noise_threshold_id}.compact)
 
         nil
       end
 
+      # Returns a specified [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+      # @param noise_threshold_id ID of the noise threshold that you want to get.
+      # @return [Seam::Resources::NoiseThreshold] OK
       def get(noise_threshold_id:)
         res = @client.post("/noise_sensors/noise_thresholds/get", {noise_threshold_id: noise_threshold_id}.compact)
 
         Seam::Resources::NoiseThreshold.load_from_response(res.body["noise_threshold"])
       end
 
+      # Returns a list of all [noise thresholds](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+      # @param device_id ID of the device for which you want to list noise thresholds.
+      # @return [Seam::Resources::NoiseThreshold] OK
       def list(device_id:)
         res = @client.post("/noise_sensors/noise_thresholds/list", {device_id: device_id}.compact)
 
         Seam::Resources::NoiseThreshold.load_from_response(res.body["noise_thresholds"])
       end
 
+      # Updates a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors).
+      # @param device_id ID of the device that contains the noise threshold that you want to update.
+      # @param noise_threshold_id ID of the noise threshold that you want to update.
+      # @param ends_daily_at Time at which the noise threshold should become inactive daily.
+      # @param name Name of the noise threshold that you want to update.
+      # @param noise_threshold_decibels Noise level in decibels for the noise threshold.
+      # @param noise_threshold_nrs Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/device-and-system-integration-guides/noiseaware-sensors).
+      # @param starts_daily_at Time at which the noise threshold should become active daily.
+      # @return [nil] OK
       def update(device_id:, noise_threshold_id:, ends_daily_at: nil, name: nil, noise_threshold_decibels: nil, noise_threshold_nrs: nil, starts_daily_at: nil)
         @client.post("/noise_sensors/noise_thresholds/update", {device_id: device_id, noise_threshold_id: noise_threshold_id, ends_daily_at: ends_daily_at, name: name, noise_threshold_decibels: noise_threshold_decibels, noise_threshold_nrs: noise_threshold_nrs, starts_daily_at: starts_daily_at}.compact)
 

data/lib/seam/routes/noise_sensors_simulate.rb

@@ -8,6 +8,9 @@ module Seam
         @defaults = defaults
       end
 
+      # Simulates the triggering of a [noise threshold](https://docs.seam.co/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/capability-guides/noise-sensors) in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
+      # @param device_id ID of the device for which you want to simulate the triggering of a noise threshold.
+      # @return [nil] OK
       def trigger_noise_threshold(device_id:)
         @client.post("/noise_sensors/simulate/trigger_noise_threshold", {device_id: device_id}.compact)
 

data/lib/seam/routes/phones.rb

@@ -12,18 +12,28 @@ module Seam
         @simulate ||= Seam::Clients::PhonesSimulate.new(client: @client, defaults: @defaults)
       end
 
+      # Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).
+      # @param device_id Device ID of the phone that you want to deactivate.
+      # @return [nil] OK
       def deactivate(device_id:)
         @client.post("/phones/deactivate", {device_id: device_id}.compact)
 
         nil
       end
 
+      # Returns a specified [phone](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity).
+      # @param device_id Device ID of the phone that you want to get.
+      # @return [Seam::Resources::Phone] OK
       def get(device_id:)
         res = @client.post("/phones/get", {device_id: device_id}.compact)
 
         Seam::Resources::Phone.load_from_response(res.body["phone"])
       end
 
+      # Returns a list of all [phones](https://docs.seam.co/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
+      # @param acs_credential_id ID of the [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones.
+      # @param owner_user_identity_id ID of the user identity that represents the owner by which you want to filter the list of returned phones.
+      # @return [Seam::Resources::Phone] OK
       def list(acs_credential_id: nil, owner_user_identity_id: nil)
         res = @client.post("/phones/list", {acs_credential_id: acs_credential_id, owner_user_identity_id: owner_user_identity_id}.compact)
 

data/lib/seam/routes/phones_simulate.rb

@@ -8,6 +8,12 @@ module Seam
         @defaults = defaults
       end
 
+      # Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://docs.seam.co/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).
+      # @param user_identity_id ID of the user identity that you want to associate with the simulated phone.
+      # @param assa_abloy_metadata ASSA ABLOY metadata that you want to associate with the simulated phone.
+      # @param custom_sdk_installation_id ID of the custom SDK installation that you want to use for the simulated phone.
+      # @param phone_metadata Metadata that you want to associate with the simulated phone.
+      # @return [Seam::Resources::Phone] OK
       def create_sandbox_phone(user_identity_id:, assa_abloy_metadata: nil, custom_sdk_installation_id: nil, phone_metadata: nil)
         res = @client.post("/phones/simulate/create_sandbox_phone", {user_identity_id: user_identity_id, assa_abloy_metadata: assa_abloy_metadata, custom_sdk_installation_id: custom_sdk_installation_id, phone_metadata: phone_metadata}.compact)
 

data/lib/seam/routes/spaces.rb

@@ -8,72 +8,133 @@ module Seam
         @defaults = defaults
       end
 
+      # Adds [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
+      # @param acs_entrance_ids IDs of the entrances that you want to add to the space.
+      # @param space_id ID of the space to which you want to add entrances.
+      # @return [nil] OK
       def add_acs_entrances(acs_entrance_ids:, space_id:)
         @client.post("/spaces/add_acs_entrances", {acs_entrance_ids: acs_entrance_ids, space_id: space_id}.compact)
 
         nil
       end
 
+      # Adds a [connected account](https://docs.seam.co/core-concepts/connected-accounts) to a specific space.
+      # @param connected_account_id ID of the connected account that you want to add to the space.
+      # @param space_id ID of the space to which you want to add the connected account.
+      # @return [nil] OK
       def add_connected_account(connected_account_id:, space_id:)
         @client.post("/spaces/add_connected_account", {connected_account_id: connected_account_id, space_id: space_id}.compact)
 
         nil
       end
 
+      # Adds devices to a specific space.
+      # @param device_ids IDs of the devices that you want to add to the space.
+      # @param space_id ID of the space to which you want to add devices.
+      # @return [nil] OK
       def add_devices(device_ids:, space_id:)
         @client.post("/spaces/add_devices", {device_ids: device_ids, space_id: space_id}.compact)
 
         nil
       end
 
+      # Creates a new space.
+      # @param name Name of the space that you want to create.
+      # @param acs_entrance_ids IDs of the entrances that you want to add to the new space.
+      # @param connected_account_ids 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.
+      # @param customer_data Reservation/stay-related defaults for the space.
+      # @param customer_key Customer key for which you want to create the space.
+      # @param device_ids IDs of the devices that you want to add to the new space.
+      # @param space_key Unique key for the space within the workspace.
+      # @return [Seam::Resources::Space] OK
       def create(name:, acs_entrance_ids: nil, connected_account_ids: nil, customer_data: nil, customer_key: nil, device_ids: nil, space_key: nil)
         res = @client.post("/spaces/create", {name: name, acs_entrance_ids: acs_entrance_ids, connected_account_ids: connected_account_ids, customer_data: customer_data, customer_key: customer_key, device_ids: device_ids, space_key: space_key}.compact)
 
         Seam::Resources::Space.load_from_response(res.body["space"])
       end
 
+      # Deletes a space.
+      # @param space_id ID of the space that you want to delete.
+      # @return [nil] OK
       def delete(space_id:)
         @client.post("/spaces/delete", {space_id: space_id}.compact)
 
         nil
       end
 
+      # Gets a space.
+      # @param space_id ID of the space that you want to get.
+      # @param space_key Unique key of the space that you want to get.
+      # @return [Seam::Resources::Space] OK
       def get(space_id: nil, space_key: nil)
         res = @client.post("/spaces/get", {space_id: space_id, space_key: space_key}.compact)
 
         Seam::Resources::Space.load_from_response(res.body["space"])
       end
 
+      # Gets all related resources for one or more Spaces.
+      # @param exclude
+      # @param include
+      # @param space_ids IDs of the spaces that you want to get along with their related resources.
+      # @param space_keys Keys of the spaces that you want to get along with their related resources.
+      # @return [Seam::Resources::Batch] OK
       def get_related(exclude: nil, include: nil, space_ids: nil, space_keys: nil)
         res = @client.post("/spaces/get_related", {exclude: exclude, include: include, space_ids: space_ids, space_keys: space_keys}.compact)
 
         Seam::Resources::Batch.load_from_response(res.body["batch"])
       end
 
+      # Returns a list of all spaces.
+      # @param customer_key Customer key for which you want to list spaces.
+      # @param limit Maximum number of records to return per page.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`.
+      # @param space_key Filter spaces by space_key.
+      # @return [Seam::Resources::Space] OK
       def list(customer_key: nil, limit: nil, page_cursor: nil, search: nil, space_key: nil)
         res = @client.post("/spaces/list", {customer_key: customer_key, limit: limit, page_cursor: page_cursor, search: search, space_key: space_key}.compact)
 
         Seam::Resources::Space.load_from_response(res.body["spaces"])
       end
 
+      # Removes [entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
+      # @param acs_entrance_ids IDs of the entrances that you want to remove from the space.
+      # @param space_id ID of the space from which you want to remove entrances.
+      # @return [nil] OK
       def remove_acs_entrances(acs_entrance_ids:, space_id:)
         @client.post("/spaces/remove_acs_entrances", {acs_entrance_ids: acs_entrance_ids, space_id: space_id}.compact)
 
         nil
       end
 
+      # Removes a [connected account](https://docs.seam.co/core-concepts/connected-accounts) from a specific space.
+      # @param connected_account_id ID of the connected account that you want to remove from the space.
+      # @param space_id ID of the space from which you want to remove the connected account.
+      # @return [nil] OK
       def remove_connected_account(connected_account_id:, space_id:)
         @client.post("/spaces/remove_connected_account", {connected_account_id: connected_account_id, space_id: space_id}.compact)
 
         nil
       end
 
+      # Removes devices from a specific space.
+      # @param device_ids IDs of the devices that you want to remove from the space.
+      # @param space_id ID of the space from which you want to remove devices.
+      # @return [nil] OK
       def remove_devices(device_ids:, space_id:)
         @client.post("/spaces/remove_devices", {device_ids: device_ids, space_id: space_id}.compact)
 
         nil
       end
 
+      # Updates an existing space.
+      # @param acs_entrance_ids IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances.
+      # @param customer_data 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.
+      # @param device_ids IDs of the devices that you want to set for the space. If specified, this will replace all existing devices.
+      # @param name Name of the space.
+      # @param space_id ID of the space that you want to update.
+      # @param space_key Unique key of the space that you want to update.
+      # @return [Seam::Resources::Space] OK
       def update(acs_entrance_ids: nil, customer_data: nil, device_ids: nil, name: nil, space_id: nil, space_key: nil)
         res = @client.post("/spaces/update", {acs_entrance_ids: acs_entrance_ids, customer_data: customer_data, device_ids: device_ids, name: name, space_id: space_id, space_key: space_key}.compact)
 

data/lib/seam/routes/thermostats.rb

@@ -22,6 +22,10 @@ module Seam
         @simulate ||= Seam::Clients::ThermostatsSimulate.new(client: @client, defaults: @defaults)
       end
 
+      # Activates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param climate_preset_key Climate preset key of the climate preset that you want to activate.
+      # @param device_id ID of the thermostat device for which you want to activate a climate preset.
+      # @return [Seam::Resources::ActionAttempt] OK
       def activate_climate_preset(climate_preset_key:, device_id:, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/activate_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id}.compact)
 
@@ -30,6 +34,11 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [cool mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+      # @param device_id ID of the thermostat device that you want to set to cool mode.
+      # @param cooling_set_point_celsius [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
+      # @param cooling_set_point_fahrenheit [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
+      # @return [Seam::Resources::ActionAttempt] OK
       def cool(device_id:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/cool", {device_id: device_id, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit}.compact)
 
@@ -38,18 +47,42 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Creates a [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param climate_preset_key Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets).
+      # @param device_id ID of the thermostat device for which you want create a climate preset.
+      # @param climate_preset_mode The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
+      # @param cooling_set_point_celsius Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param cooling_set_point_fahrenheit Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param ecobee_metadata Metadata specific to the Ecobee climate, if applicable.
+      # @param fan_mode_setting Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+      # @param heating_set_point_celsius Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param heating_set_point_fahrenheit Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param hvac_mode_setting Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+      # @param manual_override_allowed Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
+      # @deprecated manual_override_allowed: Use 'thermostat_schedule.is_override_allowed'
+      # @param name User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets).
+      # @return [nil] OK
       def create_climate_preset(climate_preset_key:, device_id:, climate_preset_mode: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, ecobee_metadata: nil, fan_mode_setting: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, manual_override_allowed: nil, name: nil)
         @client.post("/thermostats/create_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id, climate_preset_mode: climate_preset_mode, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, ecobee_metadata: ecobee_metadata, fan_mode_setting: fan_mode_setting, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, manual_override_allowed: manual_override_allowed, name: name}.compact)
 
         nil
       end
 
+      # Deletes a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param climate_preset_key Climate preset key of the climate preset that you want to delete.
+      # @param device_id ID of the thermostat device for which you want to delete a climate preset.
+      # @return [nil] OK
       def delete_climate_preset(climate_preset_key:, device_id:)
         @client.post("/thermostats/delete_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id}.compact)
 
         nil
       end
 
+      # Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+      # @param device_id ID of the thermostat device that you want to set to heat mode.
+      # @param heating_set_point_celsius [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
+      # @param heating_set_point_fahrenheit [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
+      # @return [Seam::Resources::ActionAttempt] OK
       def heat(device_id:, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/heat", {device_id: device_id, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit}.compact)
 
@@ -58,6 +91,13 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+      # @param device_id ID of the thermostat device that you want to set to heat-cool mode.
+      # @param cooling_set_point_celsius [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
+      # @param cooling_set_point_fahrenheit [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
+      # @param heating_set_point_celsius [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
+      # @param heating_set_point_fahrenheit [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
+      # @return [Seam::Resources::ActionAttempt] OK
       def heat_cool(device_id:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/heat_cool", {device_id: device_id, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit}.compact)
 
@@ -66,12 +106,34 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Returns a list of all [thermostats](https://docs.seam.co/capability-guides/thermostats).
+      # @param connect_webview_id ID of the Connect Webview for which you want to list devices.
+      # @param connected_account_id ID of the connected account for which you want to list devices.
+      # @param connected_account_ids Array of IDs of the connected accounts for which you want to list devices.
+      # @param created_before Timestamp by which to limit returned devices. Returns devices created before this timestamp.
+      # @param custom_metadata_has 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.
+      # @param customer_key Customer key for which you want to list devices.
+      # @param device_ids Array of device IDs for which you want to list devices.
+      # @param device_type Device type by which you want to filter thermostat devices.
+      # @param device_types Array of device types by which you want to filter thermostat devices.
+      # @param limit Numerical limit on the number of devices to return.
+      # @param manufacturer Manufacturer by which you want to filter thermostat devices.
+      # @param page_cursor Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
+      # @param search 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`.
+      # @param space_id ID of the space for which you want to list devices.
+      # @param unstable_location_id
+      # @deprecated unstable_location_id: Use `space_id`.
+      # @param user_identifier_key Your own internal user ID for the user for which you want to list devices.
+      # @return [Seam::Resources::Device] OK
       def list(connect_webview_id: nil, connected_account_id: nil, connected_account_ids: nil, created_before: nil, custom_metadata_has: nil, customer_key: nil, device_ids: nil, device_type: nil, device_types: nil, limit: nil, manufacturer: nil, page_cursor: nil, search: nil, space_id: nil, unstable_location_id: nil, user_identifier_key: nil)
         res = @client.post("/thermostats/list", {connect_webview_id: connect_webview_id, connected_account_id: connected_account_id, connected_account_ids: connected_account_ids, created_before: created_before, custom_metadata_has: custom_metadata_has, customer_key: customer_key, device_ids: device_ids, device_type: device_type, device_types: device_types, limit: limit, manufacturer: manufacturer, page_cursor: page_cursor, search: search, space_id: space_id, unstable_location_id: unstable_location_id, user_identifier_key: user_identifier_key}.compact)
 
         Seam::Resources::Device.load_from_response(res.body["devices"])
       end
 
+      # Sets a specified [thermostat](https://docs.seam.co/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings).
+      # @param device_id ID of the thermostat device that you want to set to off mode.
+      # @return [Seam::Resources::ActionAttempt] OK
       def off(device_id:, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/off", {device_id: device_id}.compact)
 
@@ -80,12 +142,22 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Sets a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param climate_preset_key Climate preset key of the climate preset that you want to set as the fallback climate preset.
+      # @param device_id ID of the thermostat device for which you want to set the fallback climate preset.
+      # @return [nil] OK
       def set_fallback_climate_preset(climate_preset_key:, device_id:)
         @client.post("/thermostats/set_fallback_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id}.compact)
 
         nil
       end
 
+      # Sets the [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param device_id ID of the thermostat device for which you want to set the fan mode.
+      # @param fan_mode Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.
+      # @deprecated fan_mode: Use `fan_mode_setting` instead.
+      # @param fan_mode_setting [Fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat.
+      # @return [Seam::Resources::ActionAttempt] OK
       def set_fan_mode(device_id:, fan_mode: nil, fan_mode_setting: nil, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/set_fan_mode", {device_id: device_id, fan_mode: fan_mode, fan_mode_setting: fan_mode_setting}.compact)
 
@@ -94,6 +166,14 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Sets the [HVAC mode](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param device_id ID of the thermostat device for which you want to set the HVAC mode.
+      # @param hvac_mode_setting
+      # @param cooling_set_point_celsius [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
+      # @param cooling_set_point_fahrenheit [Cooling set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters.
+      # @param heating_set_point_celsius [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
+      # @param heating_set_point_fahrenheit [Heating set point](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters.
+      # @return [Seam::Resources::ActionAttempt] OK
       def set_hvac_mode(device_id:, hvac_mode_setting:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/set_hvac_mode", {device_id: device_id, hvac_mode_setting: hvac_mode_setting, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit}.compact)
 
@@ -102,18 +182,50 @@ module Seam
         Helpers::ActionAttempt.decide_and_wait(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
       end
 
+      # Sets a [temperature threshold](https://docs.seam.co/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
+      # @param device_id ID of the thermostat device for which you want to set a temperature threshold.
+      # @param lower_limit_celsius Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
+      # @param lower_limit_fahrenheit Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.
+      # @param upper_limit_celsius Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
+      # @param upper_limit_fahrenheit Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.
+      # @return [nil] OK
       def set_temperature_threshold(device_id:, lower_limit_celsius: nil, lower_limit_fahrenheit: nil, upper_limit_celsius: nil, upper_limit_fahrenheit: nil)
         @client.post("/thermostats/set_temperature_threshold", {device_id: device_id, lower_limit_celsius: lower_limit_celsius, lower_limit_fahrenheit: lower_limit_fahrenheit, upper_limit_celsius: upper_limit_celsius, upper_limit_fahrenheit: upper_limit_fahrenheit}.compact)
 
         nil
       end
 
+      # Updates a specified [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/capability-guides/thermostats).
+      # @param climate_preset_key Unique key to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets).
+      # @param device_id ID of the thermostat device for which you want to update a climate preset.
+      # @param climate_preset_mode The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
+      # @param cooling_set_point_celsius Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param cooling_set_point_fahrenheit Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param ecobee_metadata Metadata specific to the Ecobee climate, if applicable.
+      # @param fan_mode_setting Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
+      # @param heating_set_point_celsius Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param heating_set_point_fahrenheit Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
+      # @param hvac_mode_setting Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
+      # @param manual_override_allowed Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
+      # @deprecated manual_override_allowed: Use 'thermostat_schedule.is_override_allowed'
+      # @param name User-friendly name to identify the [climate preset](https://docs.seam.co/capability-guides/thermostats/creating-and-managing-climate-presets).
+      # @return [nil] OK
       def update_climate_preset(climate_preset_key:, device_id:, climate_preset_mode: nil, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, ecobee_metadata: nil, fan_mode_setting: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, hvac_mode_setting: nil, manual_override_allowed: nil, name: nil)
         @client.post("/thermostats/update_climate_preset", {climate_preset_key: climate_preset_key, device_id: device_id, climate_preset_mode: climate_preset_mode, cooling_set_point_celsius: cooling_set_point_celsius, cooling_set_point_fahrenheit: cooling_set_point_fahrenheit, ecobee_metadata: ecobee_metadata, fan_mode_setting: fan_mode_setting, heating_set_point_celsius: heating_set_point_celsius, heating_set_point_fahrenheit: heating_set_point_fahrenheit, hvac_mode_setting: hvac_mode_setting, manual_override_allowed: manual_override_allowed, name: name}.compact)
 
         nil
       end
 
+      # Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.
+      # @param device_id ID of the thermostat device for which you want to update the weekly program.
+      # @param friday_program_id ID of the thermostat daily program to run on Fridays.
+      # @param monday_program_id ID of the thermostat daily program to run on Mondays.
+      # @param saturday_program_id ID of the thermostat daily program to run on Saturdays.
+      # @param sunday_program_id ID of the thermostat daily program to run on Sundays.
+      # @param thursday_program_id ID of the thermostat daily program to run on Thursdays.
+      # @param tuesday_program_id ID of the thermostat daily program to run on Tuesdays.
+      # @param wednesday_program_id ID of the thermostat daily program to run on Wednesdays.
+      # @return [Seam::Resources::ActionAttempt] OK
       def update_weekly_program(device_id:, friday_program_id: nil, monday_program_id: nil, saturday_program_id: nil, sunday_program_id: nil, thursday_program_id: nil, tuesday_program_id: nil, wednesday_program_id: nil, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/update_weekly_program", {device_id: device_id, friday_program_id: friday_program_id, monday_program_id: monday_program_id, saturday_program_id: saturday_program_id, sunday_program_id: sunday_program_id, thursday_program_id: thursday_program_id, tuesday_program_id: tuesday_program_id, wednesday_program_id: wednesday_program_id}.compact)
 

data/lib/seam/routes/thermostats_daily_programs.rb

@@ -10,18 +10,31 @@ module Seam
         @defaults = defaults
       end
 
+      # 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.
+      # @param device_id ID of the thermostat device for which you want to create a daily program.
+      # @param name Name of the thermostat daily program.
+      # @param periods Array of thermostat daily program periods.
+      # @return [Seam::Resources::ThermostatDailyProgram] OK
       def create(device_id:, name:, periods:)
         res = @client.post("/thermostats/daily_programs/create", {device_id: device_id, name: name, periods: periods}.compact)
 
         Seam::Resources::ThermostatDailyProgram.load_from_response(res.body["thermostat_daily_program"])
       end
 
+      # Deletes a thermostat daily program.
+      # @param thermostat_daily_program_id ID of the thermostat daily program that you want to delete.
+      # @return [nil] OK
       def delete(thermostat_daily_program_id:)
         @client.post("/thermostats/daily_programs/delete", {thermostat_daily_program_id: thermostat_daily_program_id}.compact)
 
         nil
       end
 
+      # Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.
+      # @param name Name of the thermostat daily program that you want to update.
+      # @param periods Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.
+      # @param thermostat_daily_program_id ID of the thermostat daily program that you want to update.
+      # @return [Seam::Resources::ActionAttempt] OK
       def update(name:, periods:, thermostat_daily_program_id:, wait_for_action_attempt: nil)
         res = @client.post("/thermostats/daily_programs/update", {name: name, periods: periods, thermostat_daily_program_id: thermostat_daily_program_id}.compact)