seam 2.157.0 → 2.158.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/lib/seam/resources/access_code.rb +18 -18
- data/lib/seam/resources/access_grant.rb +4 -4
- data/lib/seam/resources/access_method.rb +9 -9
- data/lib/seam/resources/acs_access_group.rb +3 -3
- data/lib/seam/resources/acs_credential.rb +35 -35
- data/lib/seam/resources/acs_encoder.rb +10 -10
- data/lib/seam/resources/acs_entrance.rb +20 -20
- data/lib/seam/resources/acs_system.rb +37 -37
- data/lib/seam/resources/acs_user.rb +35 -35
- data/lib/seam/resources/action_attempt.rb +101 -101
- data/lib/seam/resources/batch.rb +30 -30
- data/lib/seam/resources/client_session.rb +12 -12
- data/lib/seam/resources/connect_webview.rb +6 -6
- data/lib/seam/resources/connected_account.rb +9 -9
- data/lib/seam/resources/device.rb +84 -84
- data/lib/seam/resources/event.rb +60 -60
- data/lib/seam/resources/noise_threshold.rb +2 -2
- data/lib/seam/resources/phone.rb +1 -1
- data/lib/seam/resources/thermostat_daily_program.rb +1 -1
- data/lib/seam/resources/thermostat_schedule.rb +11 -11
- data/lib/seam/resources/unmanaged_access_code.rb +15 -15
- data/lib/seam/resources/unmanaged_access_grant.rb +4 -4
- data/lib/seam/resources/unmanaged_access_method.rb +9 -9
- data/lib/seam/resources/unmanaged_device.rb +10 -10
- data/lib/seam/resources/user_identity.rb +1 -1
- data/lib/seam/resources/webhook.rb +4 -4
- data/lib/seam/resources/workspace.rb +12 -12
- data/lib/seam/routes/access_codes.rb +28 -28
- data/lib/seam/routes/access_codes_simulate.rb +1 -1
- data/lib/seam/routes/access_codes_unmanaged.rb +9 -9
- data/lib/seam/routes/access_grants.rb +3 -3
- data/lib/seam/routes/access_methods.rb +2 -2
- data/lib/seam/routes/acs_access_groups.rb +7 -7
- data/lib/seam/routes/acs_credentials.rb +11 -11
- data/lib/seam/routes/acs_encoders.rb +5 -5
- data/lib/seam/routes/acs_encoders_simulate.rb +4 -4
- data/lib/seam/routes/acs_entrances.rb +5 -5
- data/lib/seam/routes/acs_systems.rb +3 -3
- data/lib/seam/routes/acs_users.rb +16 -16
- data/lib/seam/routes/action_attempts.rb +2 -2
- data/lib/seam/routes/client_sessions.rb +22 -22
- data/lib/seam/routes/connect_webviews.rb +11 -11
- data/lib/seam/routes/connected_accounts.rb +7 -7
- data/lib/seam/routes/connected_accounts_simulate.rb +1 -1
- data/lib/seam/routes/devices.rb +9 -9
- data/lib/seam/routes/devices_simulate.rb +3 -3
- data/lib/seam/routes/devices_unmanaged.rb +6 -6
- data/lib/seam/routes/events.rb +2 -2
- data/lib/seam/routes/instant_keys.rb +3 -3
- data/lib/seam/routes/locks.rb +5 -5
- data/lib/seam/routes/locks_simulate.rb +2 -2
- data/lib/seam/routes/noise_sensors.rb +1 -1
- data/lib/seam/routes/noise_sensors_noise_thresholds.rb +7 -7
- data/lib/seam/routes/noise_sensors_simulate.rb +1 -1
- data/lib/seam/routes/phones.rb +4 -4
- data/lib/seam/routes/phones_simulate.rb +1 -1
- data/lib/seam/routes/spaces.rb +4 -4
- data/lib/seam/routes/thermostats.rb +43 -43
- data/lib/seam/routes/thermostats_schedules.rb +11 -11
- data/lib/seam/routes/thermostats_simulate.rb +6 -6
- data/lib/seam/routes/user_identities.rb +15 -15
- data/lib/seam/routes/user_identities_unmanaged.rb +3 -3
- data/lib/seam/routes/webhooks.rb +5 -5
- data/lib/seam/routes/workspaces.rb +8 -8
- data/lib/seam/version.rb +1 -1
- metadata +1 -1
|
@@ -8,7 +8,7 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Deletes a specified [Instant Key](https://
|
|
11
|
+
# Deletes a specified [Instant Key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
12
12
|
# @param instant_key_id [String] ID of the Instant Key that you want to delete.
|
|
13
13
|
# @return [nil] OK
|
|
14
14
|
def delete(instant_key_id:)
|
|
@@ -17,7 +17,7 @@ module Seam
|
|
|
17
17
|
nil
|
|
18
18
|
end
|
|
19
19
|
|
|
20
|
-
# Gets an [instant key](https://
|
|
20
|
+
# Gets an [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
21
21
|
# @param instant_key_id [String, nil] ID of the instant key to get.
|
|
22
22
|
# @param instant_key_url [String, nil] URL of the instant key to get.
|
|
23
23
|
# @return [Seam::Resources::InstantKey] OK
|
|
@@ -31,7 +31,7 @@ module Seam
|
|
|
31
31
|
Seam::Resources::InstantKey.load_from_response(res.body["instant_key"])
|
|
32
32
|
end
|
|
33
33
|
|
|
34
|
-
# Returns a list of all [instant keys](https://
|
|
34
|
+
# Returns a list of all [instant keys](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
35
35
|
# @param user_identity_id [String, nil] ID of the user identity by which you want to filter the list of Instant Keys.
|
|
36
36
|
# @return [Seam::Resources::InstantKey] OK
|
|
37
37
|
def list(user_identity_id: nil)
|
data/lib/seam/routes/locks.rb
CHANGED
|
@@ -14,7 +14,7 @@ module Seam
|
|
|
14
14
|
@simulate ||= Seam::Clients::LocksSimulate.new(client: @client, defaults: @defaults)
|
|
15
15
|
end
|
|
16
16
|
|
|
17
|
-
# Configures the auto-lock setting for a specified [lock](https://
|
|
17
|
+
# Configures the auto-lock setting for a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
18
18
|
# @param auto_lock_enabled [Boolean] Whether to enable or disable auto-lock.
|
|
19
19
|
# @param device_id [String] ID of the lock for which you want to configure the auto-lock.
|
|
20
20
|
# @param auto_lock_delay_seconds [Float, nil] Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60.
|
|
@@ -27,7 +27,7 @@ module Seam
|
|
|
27
27
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
28
28
|
end
|
|
29
29
|
|
|
30
|
-
# Returns a specified [lock](https://
|
|
30
|
+
# Returns a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
31
31
|
# @param device_id [String, nil] ID of the lock that you want to get.
|
|
32
32
|
# @param name [String, nil] Name of the lock that you want to get.
|
|
33
33
|
# @return [Seam::Resources::Device] OK
|
|
@@ -42,7 +42,7 @@ module Seam
|
|
|
42
42
|
Seam::Resources::Device.load_from_response(res.body["device"])
|
|
43
43
|
end
|
|
44
44
|
|
|
45
|
-
# Returns a list of all [locks](https://
|
|
45
|
+
# Returns a list of all [locks](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
46
46
|
# @param connect_webview_id [String, nil] ID of the Connect Webview for which you want to list devices.
|
|
47
47
|
# @param connected_account_id [String, nil] ID of the connected account for which you want to list devices.
|
|
48
48
|
# @param customer_key [String, nil] Customer key for which you want to list devices.
|
|
@@ -56,7 +56,7 @@ module Seam
|
|
|
56
56
|
Seam::Resources::Device.load_from_response(res.body["devices"])
|
|
57
57
|
end
|
|
58
58
|
|
|
59
|
-
# Locks a [lock](https://
|
|
59
|
+
# Locks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock).
|
|
60
60
|
# @param device_id [String] ID of the lock that you want to lock.
|
|
61
61
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
62
62
|
def lock_door(device_id:, wait_for_action_attempt: nil)
|
|
@@ -67,7 +67,7 @@ module Seam
|
|
|
67
67
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
68
68
|
end
|
|
69
69
|
|
|
70
|
-
# Unlocks a [lock](https://
|
|
70
|
+
# Unlocks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock).
|
|
71
71
|
# @param device_id [String] ID of the lock that you want to unlock.
|
|
72
72
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
73
73
|
def unlock_door(device_id:, wait_for_action_attempt: nil)
|
|
@@ -10,7 +10,7 @@ module Seam
|
|
|
10
10
|
@defaults = defaults
|
|
11
11
|
end
|
|
12
12
|
|
|
13
|
-
# Simulates the entry of a code on a keypad. You can only perform this action for [August](https://
|
|
13
|
+
# Simulates the entry of a code on a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
14
14
|
# @param code [String] Code that you want to simulate entering on a keypad.
|
|
15
15
|
# @param device_id [String] ID of the device for which you want to simulate a keypad code entry.
|
|
16
16
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
@@ -22,7 +22,7 @@ module Seam
|
|
|
22
22
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
23
23
|
end
|
|
24
24
|
|
|
25
|
-
# Simulates a manual lock action using a keypad. You can only perform this action for [August](https://
|
|
25
|
+
# Simulates a manual lock action using a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
26
26
|
# @param device_id [String] ID of the device for which you want to simulate a manual lock action using a keypad.
|
|
27
27
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
28
28
|
def manual_lock_via_keypad(device_id:, wait_for_action_attempt: nil)
|
|
@@ -16,7 +16,7 @@ module Seam
|
|
|
16
16
|
@simulate ||= Seam::Clients::NoiseSensorsSimulate.new(client: @client, defaults: @defaults)
|
|
17
17
|
end
|
|
18
18
|
|
|
19
|
-
# Returns a list of all [noise sensors](https://
|
|
19
|
+
# Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
20
20
|
# @param connect_webview_id [String, nil] ID of the Connect Webview for which you want to list devices.
|
|
21
21
|
# @param connected_account_id [String, nil] ID of the connected account for which you want to list devices.
|
|
22
22
|
# @param customer_key [String, nil] Customer key for which you want to list devices.
|
|
@@ -8,13 +8,13 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Creates a new [noise threshold](https://
|
|
11
|
+
# Creates a new [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/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.
|
|
12
12
|
# @param device_id [String] ID of the device for which you want to create a noise threshold.
|
|
13
13
|
# @param ends_daily_at [String] Time at which the new noise threshold should become inactive daily.
|
|
14
14
|
# @param starts_daily_at [String] Time at which the new noise threshold should become active daily.
|
|
15
15
|
# @param name [String, nil] Name of the new noise threshold.
|
|
16
16
|
# @param noise_threshold_decibels [Float, nil] Noise level in decibels for the new noise threshold.
|
|
17
|
-
# @param noise_threshold_nrs [Float, nil] Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://
|
|
17
|
+
# @param noise_threshold_nrs [Float, nil] Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors).
|
|
18
18
|
# @return [Seam::Resources::NoiseThreshold] OK
|
|
19
19
|
def create(device_id:, ends_daily_at:, starts_daily_at:, name: nil, noise_threshold_decibels: nil, noise_threshold_nrs: nil)
|
|
20
20
|
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)
|
|
@@ -22,7 +22,7 @@ module Seam
|
|
|
22
22
|
Seam::Resources::NoiseThreshold.load_from_response(res.body["noise_threshold"])
|
|
23
23
|
end
|
|
24
24
|
|
|
25
|
-
# Deletes a [noise threshold](https://
|
|
25
|
+
# Deletes a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
26
26
|
# @param device_id [String] ID of the device that contains the noise threshold that you want to delete.
|
|
27
27
|
# @param noise_threshold_id [String] ID of the noise threshold that you want to delete.
|
|
28
28
|
# @return [nil] OK
|
|
@@ -32,7 +32,7 @@ module Seam
|
|
|
32
32
|
nil
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
-
# Returns a specified [noise threshold](https://
|
|
35
|
+
# Returns a specified [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
36
36
|
# @param noise_threshold_id [String] ID of the noise threshold that you want to get.
|
|
37
37
|
# @return [Seam::Resources::NoiseThreshold] OK
|
|
38
38
|
def get(noise_threshold_id:)
|
|
@@ -41,7 +41,7 @@ module Seam
|
|
|
41
41
|
Seam::Resources::NoiseThreshold.load_from_response(res.body["noise_threshold"])
|
|
42
42
|
end
|
|
43
43
|
|
|
44
|
-
# Returns a list of all [noise thresholds](https://
|
|
44
|
+
# Returns a list of all [noise thresholds](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
45
45
|
# @param device_id [String] ID of the device for which you want to list noise thresholds.
|
|
46
46
|
# @return [Seam::Resources::NoiseThreshold] OK
|
|
47
47
|
def list(device_id:)
|
|
@@ -50,13 +50,13 @@ module Seam
|
|
|
50
50
|
Seam::Resources::NoiseThreshold.load_from_response(res.body["noise_thresholds"])
|
|
51
51
|
end
|
|
52
52
|
|
|
53
|
-
# Updates a [noise threshold](https://
|
|
53
|
+
# Updates a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
54
54
|
# @param device_id [String] ID of the device that contains the noise threshold that you want to update.
|
|
55
55
|
# @param noise_threshold_id [String] ID of the noise threshold that you want to update.
|
|
56
56
|
# @param ends_daily_at [String, nil] Time at which the noise threshold should become inactive daily.
|
|
57
57
|
# @param name [String, nil] Name of the noise threshold that you want to update.
|
|
58
58
|
# @param noise_threshold_decibels [Float, nil] Noise level in decibels for the noise threshold.
|
|
59
|
-
# @param noise_threshold_nrs [Float, nil] Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://
|
|
59
|
+
# @param noise_threshold_nrs [Float, nil] Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors).
|
|
60
60
|
# @param starts_daily_at [String, nil] Time at which the noise threshold should become active daily.
|
|
61
61
|
# @return [nil] OK
|
|
62
62
|
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)
|
|
@@ -8,7 +8,7 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Simulates the triggering of a [noise threshold](https://
|
|
11
|
+
# Simulates the triggering of a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
12
12
|
# @param device_id [String] ID of the device for which you want to simulate the triggering of a noise threshold.
|
|
13
13
|
# @return [nil] OK
|
|
14
14
|
def trigger_noise_threshold(device_id:)
|
data/lib/seam/routes/phones.rb
CHANGED
|
@@ -12,7 +12,7 @@ module Seam
|
|
|
12
12
|
@simulate ||= Seam::Clients::PhonesSimulate.new(client: @client, defaults: @defaults)
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
-
# 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://
|
|
15
|
+
# 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://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).
|
|
16
16
|
# @param device_id [String] Device ID of the phone that you want to deactivate.
|
|
17
17
|
# @return [nil] OK
|
|
18
18
|
def deactivate(device_id:)
|
|
@@ -21,7 +21,7 @@ module Seam
|
|
|
21
21
|
nil
|
|
22
22
|
end
|
|
23
23
|
|
|
24
|
-
# Returns a specified [phone](https://
|
|
24
|
+
# Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity).
|
|
25
25
|
# @param device_id [String] Device ID of the phone that you want to get.
|
|
26
26
|
# @return [Seam::Resources::Phone] OK
|
|
27
27
|
def get(device_id:)
|
|
@@ -30,8 +30,8 @@ module Seam
|
|
|
30
30
|
Seam::Resources::Phone.load_from_response(res.body["phone"])
|
|
31
31
|
end
|
|
32
32
|
|
|
33
|
-
# Returns a list of all [phones](https://
|
|
34
|
-
# @param acs_credential_id [String, nil] ID of the [credential](https://
|
|
33
|
+
# Returns a list of all [phones](https://www.seam.co/docs/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.
|
|
34
|
+
# @param acs_credential_id [String, nil] ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones.
|
|
35
35
|
# @param owner_user_identity_id [String, nil] ID of the user identity that represents the owner by which you want to filter the list of returned phones.
|
|
36
36
|
# @return [Seam::Resources::Phone] OK
|
|
37
37
|
def list(acs_credential_id: nil, owner_user_identity_id: nil)
|
|
@@ -8,7 +8,7 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Creates a new simulated phone in a [sandbox workspace](https://
|
|
11
|
+
# Creates a new simulated phone in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://www.seam.co/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).
|
|
12
12
|
# @param user_identity_id [String] ID of the user identity that you want to associate with the simulated phone.
|
|
13
13
|
# @param assa_abloy_metadata [Hash, nil] ASSA ABLOY metadata that you want to associate with the simulated phone.
|
|
14
14
|
# @param custom_sdk_installation_id [String, nil] ID of the custom SDK installation that you want to use for the simulated phone.
|
data/lib/seam/routes/spaces.rb
CHANGED
|
@@ -8,7 +8,7 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Adds [entrances](https://
|
|
11
|
+
# Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
|
|
12
12
|
# @param acs_entrance_ids [Array<String>] IDs of the entrances that you want to add to the space.
|
|
13
13
|
# @param space_id [String] ID of the space to which you want to add entrances.
|
|
14
14
|
# @return [nil] OK
|
|
@@ -18,7 +18,7 @@ module Seam
|
|
|
18
18
|
nil
|
|
19
19
|
end
|
|
20
20
|
|
|
21
|
-
# Adds a [connected account](https://
|
|
21
|
+
# Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space.
|
|
22
22
|
# @param connected_account_id [String] ID of the connected account that you want to add to the space.
|
|
23
23
|
# @param space_id [String] ID of the space to which you want to add the connected account.
|
|
24
24
|
# @return [nil] OK
|
|
@@ -105,7 +105,7 @@ module Seam
|
|
|
105
105
|
Seam::Resources::Space.load_from_response(res.body["spaces"])
|
|
106
106
|
end
|
|
107
107
|
|
|
108
|
-
# Removes [entrances](https://
|
|
108
|
+
# Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
|
|
109
109
|
# @param acs_entrance_ids [Array<String>] IDs of the entrances that you want to remove from the space.
|
|
110
110
|
# @param space_id [String] ID of the space from which you want to remove entrances.
|
|
111
111
|
# @return [nil] OK
|
|
@@ -115,7 +115,7 @@ module Seam
|
|
|
115
115
|
nil
|
|
116
116
|
end
|
|
117
117
|
|
|
118
|
-
# Removes a [connected account](https://
|
|
118
|
+
# Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space.
|
|
119
119
|
# @param connected_account_id [String] ID of the connected account that you want to remove from the space.
|
|
120
120
|
# @param space_id [String] ID of the space from which you want to remove the connected account.
|
|
121
121
|
# @return [nil] OK
|
|
@@ -22,7 +22,7 @@ module Seam
|
|
|
22
22
|
@simulate ||= Seam::Clients::ThermostatsSimulate.new(client: @client, defaults: @defaults)
|
|
23
23
|
end
|
|
24
24
|
|
|
25
|
-
# Activates a specified [climate preset](https://
|
|
25
|
+
# Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
26
26
|
# @param climate_preset_key [String] Climate preset key of the climate preset that you want to activate.
|
|
27
27
|
# @param device_id [String] ID of the thermostat device for which you want to activate a climate preset.
|
|
28
28
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
@@ -34,10 +34,10 @@ module Seam
|
|
|
34
34
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
35
35
|
end
|
|
36
36
|
|
|
37
|
-
# Sets a specified [thermostat](https://
|
|
37
|
+
# Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
38
38
|
# @param device_id [String] ID of the thermostat device that you want to set to cool mode.
|
|
39
|
-
# @param cooling_set_point_celsius [Float, nil] [Cooling set point](https://
|
|
40
|
-
# @param cooling_set_point_fahrenheit [Float, nil] [Cooling set point](https://
|
|
39
|
+
# @param cooling_set_point_celsius [Float, nil] [Cooling set point](https://www.seam.co/docs/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.
|
|
40
|
+
# @param cooling_set_point_fahrenheit [Float, nil] [Cooling set point](https://www.seam.co/docs/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.
|
|
41
41
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
42
42
|
def cool(device_id:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, wait_for_action_attempt: nil)
|
|
43
43
|
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)
|
|
@@ -47,20 +47,20 @@ module Seam
|
|
|
47
47
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
48
48
|
end
|
|
49
49
|
|
|
50
|
-
# Creates a [climate preset](https://
|
|
51
|
-
# @param climate_preset_key [String] Unique key to identify the [climate preset](https://
|
|
50
|
+
# Creates a [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
51
|
+
# @param climate_preset_key [String] Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
52
52
|
# @param device_id [String] ID of the thermostat device for which you want create a climate preset.
|
|
53
53
|
# @param climate_preset_mode [String, nil] The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
54
|
-
# @param cooling_set_point_celsius [Float, nil] Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
55
|
-
# @param cooling_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
54
|
+
# @param cooling_set_point_celsius [Float, nil] Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
55
|
+
# @param cooling_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
56
56
|
# @param ecobee_metadata [Hash, nil] Metadata specific to the Ecobee climate, if applicable.
|
|
57
|
-
# @param fan_mode_setting [String, nil] Desired [fan mode setting](https://
|
|
58
|
-
# @param heating_set_point_celsius [Float, nil] Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
59
|
-
# @param heating_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
60
|
-
# @param hvac_mode_setting [String, nil] Desired [HVAC mode](https://
|
|
57
|
+
# @param fan_mode_setting [String, nil] Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
58
|
+
# @param heating_set_point_celsius [Float, nil] Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
59
|
+
# @param heating_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
60
|
+
# @param hvac_mode_setting [String, nil] Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
61
61
|
# @param manual_override_allowed [Boolean, nil] Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
|
|
62
62
|
# @deprecated manual_override_allowed: Use 'thermostat_schedule.is_override_allowed'
|
|
63
|
-
# @param name [String, Seam::Null, nil] User-friendly name to identify the [climate preset](https://
|
|
63
|
+
# @param name [String, Seam::Null, nil] User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
64
64
|
# @return [nil] OK
|
|
65
65
|
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)
|
|
66
66
|
@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)
|
|
@@ -68,7 +68,7 @@ module Seam
|
|
|
68
68
|
nil
|
|
69
69
|
end
|
|
70
70
|
|
|
71
|
-
# Deletes a specified [climate preset](https://
|
|
71
|
+
# Deletes a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
72
72
|
# @param climate_preset_key [String] Climate preset key of the climate preset that you want to delete.
|
|
73
73
|
# @param device_id [String] ID of the thermostat device for which you want to delete a climate preset.
|
|
74
74
|
# @return [nil] OK
|
|
@@ -78,10 +78,10 @@ module Seam
|
|
|
78
78
|
nil
|
|
79
79
|
end
|
|
80
80
|
|
|
81
|
-
# Sets a specified [thermostat](https://
|
|
81
|
+
# Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
82
82
|
# @param device_id [String] ID of the thermostat device that you want to set to heat mode.
|
|
83
|
-
# @param heating_set_point_celsius [Float, nil] [Heating set point](https://
|
|
84
|
-
# @param heating_set_point_fahrenheit [Float, nil] [Heating set point](https://
|
|
83
|
+
# @param heating_set_point_celsius [Float, nil] [Heating set point](https://www.seam.co/docs/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.
|
|
84
|
+
# @param heating_set_point_fahrenheit [Float, nil] [Heating set point](https://www.seam.co/docs/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.
|
|
85
85
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
86
86
|
def heat(device_id:, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil, wait_for_action_attempt: nil)
|
|
87
87
|
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)
|
|
@@ -91,12 +91,12 @@ module Seam
|
|
|
91
91
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
92
92
|
end
|
|
93
93
|
|
|
94
|
-
# Sets a specified [thermostat](https://
|
|
94
|
+
# Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat-cool ("auto") mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
95
95
|
# @param device_id [String] ID of the thermostat device that you want to set to heat-cool mode.
|
|
96
|
-
# @param cooling_set_point_celsius [Float, nil] [Cooling set point](https://
|
|
97
|
-
# @param cooling_set_point_fahrenheit [Float, nil] [Cooling set point](https://
|
|
98
|
-
# @param heating_set_point_celsius [Float, nil] [Heating set point](https://
|
|
99
|
-
# @param heating_set_point_fahrenheit [Float, nil] [Heating set point](https://
|
|
96
|
+
# @param cooling_set_point_celsius [Float, nil] [Cooling set point](https://www.seam.co/docs/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.
|
|
97
|
+
# @param cooling_set_point_fahrenheit [Float, nil] [Cooling set point](https://www.seam.co/docs/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.
|
|
98
|
+
# @param heating_set_point_celsius [Float, nil] [Heating set point](https://www.seam.co/docs/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.
|
|
99
|
+
# @param heating_set_point_fahrenheit [Float, nil] [Heating set point](https://www.seam.co/docs/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.
|
|
100
100
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
101
101
|
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)
|
|
102
102
|
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)
|
|
@@ -106,7 +106,7 @@ module Seam
|
|
|
106
106
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
107
107
|
end
|
|
108
108
|
|
|
109
|
-
# Returns a list of all [thermostats](https://
|
|
109
|
+
# Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats).
|
|
110
110
|
# @param connect_webview_id [String, nil] ID of the Connect Webview for which you want to list devices.
|
|
111
111
|
# @param connected_account_id [String, nil] ID of the connected account for which you want to list devices.
|
|
112
112
|
# @param customer_key [String, nil] Customer key for which you want to list devices.
|
|
@@ -120,7 +120,7 @@ module Seam
|
|
|
120
120
|
Seam::Resources::Device.load_from_response(res.body["devices"])
|
|
121
121
|
end
|
|
122
122
|
|
|
123
|
-
# Sets a specified [thermostat](https://
|
|
123
|
+
# Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to ["off" mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
124
124
|
# @param device_id [String] ID of the thermostat device that you want to set to off mode.
|
|
125
125
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
126
126
|
def off(device_id:, wait_for_action_attempt: nil)
|
|
@@ -131,7 +131,7 @@ module Seam
|
|
|
131
131
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
132
132
|
end
|
|
133
133
|
|
|
134
|
-
# Sets a specified [climate preset](https://
|
|
134
|
+
# Sets a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
135
135
|
# @param climate_preset_key [String] Climate preset key of the climate preset that you want to set as the fallback climate preset.
|
|
136
136
|
# @param device_id [String] ID of the thermostat device for which you want to set the fallback climate preset.
|
|
137
137
|
# @return [nil] OK
|
|
@@ -141,11 +141,11 @@ module Seam
|
|
|
141
141
|
nil
|
|
142
142
|
end
|
|
143
143
|
|
|
144
|
-
# Sets the [fan mode setting](https://
|
|
144
|
+
# Sets the [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
145
145
|
# @param device_id [String] ID of the thermostat device for which you want to set the fan mode.
|
|
146
146
|
# @param fan_mode [String, nil] Fan mode setting for the thermostat, such as `auto`, `on`, or `circulate`.
|
|
147
147
|
# @deprecated fan_mode: Use `fan_mode_setting` instead.
|
|
148
|
-
# @param fan_mode_setting [String, nil] [Fan mode setting](https://
|
|
148
|
+
# @param fan_mode_setting [String, nil] [Fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat.
|
|
149
149
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
150
150
|
def set_fan_mode(device_id:, fan_mode: nil, fan_mode_setting: nil, wait_for_action_attempt: nil)
|
|
151
151
|
res = @client.post("/thermostats/set_fan_mode", {device_id: device_id, fan_mode: fan_mode, fan_mode_setting: fan_mode_setting}.compact)
|
|
@@ -155,13 +155,13 @@ module Seam
|
|
|
155
155
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
156
156
|
end
|
|
157
157
|
|
|
158
|
-
# Sets the [HVAC mode](https://
|
|
158
|
+
# Sets the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
159
159
|
# @param device_id [String] ID of the thermostat device for which you want to set the HVAC mode.
|
|
160
160
|
# @param hvac_mode_setting [String]
|
|
161
|
-
# @param cooling_set_point_celsius [Float, nil] [Cooling set point](https://
|
|
162
|
-
# @param cooling_set_point_fahrenheit [Float, nil] [Cooling set point](https://
|
|
163
|
-
# @param heating_set_point_celsius [Float, nil] [Heating set point](https://
|
|
164
|
-
# @param heating_set_point_fahrenheit [Float, nil] [Heating set point](https://
|
|
161
|
+
# @param cooling_set_point_celsius [Float, nil] [Cooling set point](https://www.seam.co/docs/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.
|
|
162
|
+
# @param cooling_set_point_fahrenheit [Float, nil] [Cooling set point](https://www.seam.co/docs/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.
|
|
163
|
+
# @param heating_set_point_celsius [Float, nil] [Heating set point](https://www.seam.co/docs/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.
|
|
164
|
+
# @param heating_set_point_fahrenheit [Float, nil] [Heating set point](https://www.seam.co/docs/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.
|
|
165
165
|
# @return [Seam::Resources::ActionAttempt] OK
|
|
166
166
|
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)
|
|
167
167
|
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)
|
|
@@ -171,7 +171,7 @@ module Seam
|
|
|
171
171
|
Seam::ActionAttemptResolver.resolve(Seam::Resources::ActionAttempt.load_from_response(res.body["action_attempt"]), @client, wait_for_action_attempt)
|
|
172
172
|
end
|
|
173
173
|
|
|
174
|
-
# Sets a [temperature threshold](https://
|
|
174
|
+
# Sets a [temperature threshold](https://www.seam.co/docs/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.
|
|
175
175
|
# @param device_id [String] ID of the thermostat device for which you want to set a temperature threshold.
|
|
176
176
|
# @param lower_limit_celsius [Float, Seam::Null, nil] 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.
|
|
177
177
|
# @param lower_limit_fahrenheit [Float, Seam::Null, nil] 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.
|
|
@@ -184,20 +184,20 @@ module Seam
|
|
|
184
184
|
nil
|
|
185
185
|
end
|
|
186
186
|
|
|
187
|
-
# Updates a specified [climate preset](https://
|
|
188
|
-
# @param climate_preset_key [String] Unique key to identify the [climate preset](https://
|
|
187
|
+
# Updates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
188
|
+
# @param climate_preset_key [String] Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
189
189
|
# @param device_id [String] ID of the thermostat device for which you want to update a climate preset.
|
|
190
190
|
# @param climate_preset_mode [String, nil] The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
191
|
-
# @param cooling_set_point_celsius [Float, nil] Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
192
|
-
# @param cooling_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
191
|
+
# @param cooling_set_point_celsius [Float, nil] Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
192
|
+
# @param cooling_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
193
193
|
# @param ecobee_metadata [Hash, nil] Metadata specific to the Ecobee climate, if applicable.
|
|
194
|
-
# @param fan_mode_setting [String, nil] Desired [fan mode setting](https://
|
|
195
|
-
# @param heating_set_point_celsius [Float, nil] Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
196
|
-
# @param heating_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
197
|
-
# @param hvac_mode_setting [String, nil] Desired [HVAC mode](https://
|
|
198
|
-
# @param manual_override_allowed [Boolean, nil] Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
194
|
+
# @param fan_mode_setting [String, nil] Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
|
|
195
|
+
# @param heating_set_point_celsius [Float, nil] Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
196
|
+
# @param heating_set_point_fahrenheit [Float, nil] Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points).
|
|
197
|
+
# @param hvac_mode_setting [String, nil] Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
|
|
198
|
+
# @param manual_override_allowed [Boolean, nil] Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
199
199
|
# @deprecated manual_override_allowed: Use 'thermostat_schedule.is_override_allowed'
|
|
200
|
-
# @param name [String, Seam::Null, nil] User-friendly name to identify the [climate preset](https://
|
|
200
|
+
# @param name [String, Seam::Null, nil] User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
201
201
|
# @return [nil] OK
|
|
202
202
|
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)
|
|
203
203
|
@client.patch("/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)
|
|
@@ -8,13 +8,13 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Creates a new [thermostat schedule](https://
|
|
12
|
-
# @param climate_preset_key [String] Key of the [climate preset](https://
|
|
11
|
+
# Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
12
|
+
# @param climate_preset_key [String] Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule.
|
|
13
13
|
# @param device_id [String] ID of the thermostat device for which you want to create a schedule.
|
|
14
14
|
# @param ends_at [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.
|
|
15
15
|
# @param starts_at [String] 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.
|
|
16
|
-
# @param is_override_allowed [Boolean, nil] 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://
|
|
17
|
-
# @param max_override_period_minutes [Integer, Seam::Null, nil] 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://
|
|
16
|
+
# @param is_override_allowed [Boolean, nil] 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://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
17
|
+
# @param max_override_period_minutes [Integer, Seam::Null, nil] 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://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
18
18
|
# @param name [String, nil] Name of the thermostat schedule.
|
|
19
19
|
# @return [Seam::Resources::ThermostatSchedule] OK
|
|
20
20
|
def create(climate_preset_key:, device_id:, ends_at:, starts_at:, is_override_allowed: nil, max_override_period_minutes: nil, name: nil)
|
|
@@ -23,7 +23,7 @@ module Seam
|
|
|
23
23
|
Seam::Resources::ThermostatSchedule.load_from_response(res.body["thermostat_schedule"])
|
|
24
24
|
end
|
|
25
25
|
|
|
26
|
-
# Deletes a [thermostat schedule](https://
|
|
26
|
+
# Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
27
27
|
# @param thermostat_schedule_id [String] ID of the thermostat schedule that you want to delete.
|
|
28
28
|
# @return [nil] OK
|
|
29
29
|
def delete(thermostat_schedule_id:)
|
|
@@ -32,7 +32,7 @@ module Seam
|
|
|
32
32
|
nil
|
|
33
33
|
end
|
|
34
34
|
|
|
35
|
-
# Returns a specified [thermostat schedule](https://
|
|
35
|
+
# Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
36
36
|
# @param thermostat_schedule_id [String] ID of the thermostat schedule that you want to get.
|
|
37
37
|
# @return [Seam::Resources::ThermostatSchedule] OK
|
|
38
38
|
def get(thermostat_schedule_id:)
|
|
@@ -41,7 +41,7 @@ module Seam
|
|
|
41
41
|
Seam::Resources::ThermostatSchedule.load_from_response(res.body["thermostat_schedule"])
|
|
42
42
|
end
|
|
43
43
|
|
|
44
|
-
# Returns a list of all [thermostat schedules](https://
|
|
44
|
+
# Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
45
45
|
# @param device_id [String] ID of the thermostat device for which you want to list schedules.
|
|
46
46
|
# @param user_identifier_key [String, nil] User identifier key by which to filter the list of returned thermostat schedules.
|
|
47
47
|
# @return [Seam::Resources::ThermostatSchedule] OK
|
|
@@ -51,12 +51,12 @@ module Seam
|
|
|
51
51
|
Seam::Resources::ThermostatSchedule.load_from_response(res.body["thermostat_schedules"])
|
|
52
52
|
end
|
|
53
53
|
|
|
54
|
-
# Updates a specified [thermostat schedule](https://
|
|
54
|
+
# Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
55
55
|
# @param thermostat_schedule_id [String] ID of the thermostat schedule that you want to update.
|
|
56
|
-
# @param climate_preset_key [String, nil] Key of the [climate preset](https://
|
|
56
|
+
# @param climate_preset_key [String, nil] Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.
|
|
57
57
|
# @param ends_at [String, nil] Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
58
|
-
# @param is_override_allowed [Boolean, nil] 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://
|
|
59
|
-
# @param max_override_period_minutes [Integer, Seam::Null, nil] 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://
|
|
58
|
+
# @param is_override_allowed [Boolean, nil] 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://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
59
|
+
# @param max_override_period_minutes [Integer, Seam::Null, nil] 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://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
60
60
|
# @param name [String, nil] Name of the thermostat schedule.
|
|
61
61
|
# @param starts_at [String, nil] Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
62
62
|
# @return [nil] OK
|
|
@@ -8,13 +8,13 @@ module Seam
|
|
|
8
8
|
@defaults = defaults
|
|
9
9
|
end
|
|
10
10
|
|
|
11
|
-
# Simulates having adjusted the [HVAC mode](https://
|
|
11
|
+
# Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
12
12
|
# @param device_id [String] ID of the thermostat device for which you want to simulate having adjusted the HVAC mode.
|
|
13
13
|
# @param hvac_mode [String] HVAC mode that you want to simulate.
|
|
14
|
-
# @param cooling_set_point_celsius [Float, nil] Cooling [set point](https://
|
|
15
|
-
# @param cooling_set_point_fahrenheit [Float, nil] Cooling [set point](https://
|
|
16
|
-
# @param heating_set_point_celsius [Float, nil] Heating [set point](https://
|
|
17
|
-
# @param heating_set_point_fahrenheit [Float, nil] Heating [set point](https://
|
|
14
|
+
# @param cooling_set_point_celsius [Float, nil] Cooling [set point](https://www.seam.co/docs/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`.
|
|
15
|
+
# @param cooling_set_point_fahrenheit [Float, nil] Cooling [set point](https://www.seam.co/docs/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`.
|
|
16
|
+
# @param heating_set_point_celsius [Float, nil] Heating [set point](https://www.seam.co/docs/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`.
|
|
17
|
+
# @param heating_set_point_fahrenheit [Float, nil] Heating [set point](https://www.seam.co/docs/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`.
|
|
18
18
|
# @return [nil] OK
|
|
19
19
|
def hvac_mode_adjusted(device_id:, hvac_mode:, cooling_set_point_celsius: nil, cooling_set_point_fahrenheit: nil, heating_set_point_celsius: nil, heating_set_point_fahrenheit: nil)
|
|
20
20
|
@client.post("/thermostats/simulate/hvac_mode_adjusted", {device_id: device_id, hvac_mode: hvac_mode, 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)
|
|
@@ -22,7 +22,7 @@ module Seam
|
|
|
22
22
|
nil
|
|
23
23
|
end
|
|
24
24
|
|
|
25
|
-
# Simulates a [thermostat](https://
|
|
25
|
+
# Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
26
26
|
# @param device_id [String] ID of the thermostat device that you want to simulate reaching a specified temperature.
|
|
27
27
|
# @param temperature_celsius [Float, nil] Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`.
|
|
28
28
|
# @param temperature_fahrenheit [Float, nil] Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`.
|