seam 2.156.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 +100 -84
- data/lib/seam/resources/device_provider.rb +1 -0
- 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 +11 -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
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Seam
|
|
4
4
|
module Resources
|
|
5
|
-
# Represents a [device](https://
|
|
5
|
+
# Represents a [device](https://www.seam.co/docs/core-concepts/devices) that has been connected to Seam.
|
|
6
6
|
class Device < BaseResource
|
|
7
7
|
class DeviceManufacturer < BaseResource
|
|
8
8
|
# Display name for the manufacturer, such as `August`, `Yale`, `Salto`, and so on.
|
|
@@ -40,7 +40,7 @@ module Seam
|
|
|
40
40
|
# Known values:
|
|
41
41
|
# - `account_disconnected`
|
|
42
42
|
attr_accessor :error_code
|
|
43
|
-
# Indicates that the error is a [connected account](https://
|
|
43
|
+
# Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
44
44
|
# @return [TrueClass]
|
|
45
45
|
attr_accessor :is_connected_account_error
|
|
46
46
|
# Indicates that the error is not a device error.
|
|
@@ -61,7 +61,7 @@ module Seam
|
|
|
61
61
|
# Known values:
|
|
62
62
|
# - `salto_ks_subscription_limit_exceeded`
|
|
63
63
|
attr_accessor :error_code
|
|
64
|
-
# Indicates that the error is a [connected account](https://
|
|
64
|
+
# Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
65
65
|
# @return [TrueClass]
|
|
66
66
|
attr_accessor :is_connected_account_error
|
|
67
67
|
# Indicates that the error is not a device error.
|
|
@@ -82,7 +82,7 @@ module Seam
|
|
|
82
82
|
# Known values:
|
|
83
83
|
# - `insufficient_permissions`
|
|
84
84
|
attr_accessor :error_code
|
|
85
|
-
# Indicates that the error is a [connected account](https://
|
|
85
|
+
# Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
86
86
|
# @return [TrueClass]
|
|
87
87
|
attr_accessor :is_connected_account_error
|
|
88
88
|
# Indicates that the error is not a device error.
|
|
@@ -103,7 +103,7 @@ module Seam
|
|
|
103
103
|
# Known values:
|
|
104
104
|
# - `dormakaba_sites_disconnected`
|
|
105
105
|
attr_accessor :error_code
|
|
106
|
-
# Indicates that the error is a [connected account](https://
|
|
106
|
+
# Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
|
|
107
107
|
# @return [TrueClass]
|
|
108
108
|
attr_accessor :is_connected_account_error
|
|
109
109
|
# Indicates that the error is not a device error.
|
|
@@ -189,7 +189,7 @@ module Seam
|
|
|
189
189
|
date_accessor :created_at
|
|
190
190
|
end
|
|
191
191
|
|
|
192
|
-
# Indicates that the [backup access code pool](https://
|
|
192
|
+
# Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
|
|
193
193
|
class EmptyBackupAccessCodePool < Errors
|
|
194
194
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
195
195
|
# @return [String]
|
|
@@ -279,14 +279,14 @@ module Seam
|
|
|
279
279
|
date_accessor :created_at
|
|
280
280
|
end
|
|
281
281
|
|
|
282
|
-
# Indicates that the Seam API cannot communicate with [Seam Bridge](https://
|
|
282
|
+
# Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
|
|
283
283
|
class BridgeDisconnected < Errors
|
|
284
284
|
# Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
|
|
285
285
|
# @return [String]
|
|
286
286
|
# Known values:
|
|
287
287
|
# - `bridge_disconnected`
|
|
288
288
|
attr_accessor :error_code
|
|
289
|
-
# Indicates whether the error is related to [Seam Bridge](https://
|
|
289
|
+
# Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
|
|
290
290
|
# @return [Boolean, nil]
|
|
291
291
|
attr_accessor :is_bridge_error
|
|
292
292
|
# Indicates whether the error is related specifically to the connected account.
|
|
@@ -1137,6 +1137,18 @@ module Seam
|
|
|
1137
1137
|
attr_accessor :serial_no
|
|
1138
1138
|
end
|
|
1139
1139
|
|
|
1140
|
+
class TapoMetadata < BaseResource
|
|
1141
|
+
# Firmware version reported by the camera.
|
|
1142
|
+
# @return [String, nil]
|
|
1143
|
+
attr_accessor :firmware_version
|
|
1144
|
+
# Hardware version reported by the camera.
|
|
1145
|
+
# @return [String, nil]
|
|
1146
|
+
attr_accessor :hardware_version
|
|
1147
|
+
# Model reported by the Tapo camera.
|
|
1148
|
+
# @return [String, nil]
|
|
1149
|
+
attr_accessor :model
|
|
1150
|
+
end
|
|
1151
|
+
|
|
1140
1152
|
class TedeeMetadata < BaseResource
|
|
1141
1153
|
# Bridge ID for a Tedee device.
|
|
1142
1154
|
# @return [Float, nil]
|
|
@@ -1413,37 +1425,37 @@ module Seam
|
|
|
1413
1425
|
date_accessor :created_at
|
|
1414
1426
|
end
|
|
1415
1427
|
|
|
1416
|
-
# Errors associated with the [thermostat schedule](https://
|
|
1428
|
+
# Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1417
1429
|
# @return [Array<Errors>]
|
|
1418
1430
|
resource_list_accessor :errors, Errors
|
|
1419
|
-
# Key of the [climate preset](https://
|
|
1431
|
+
# Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1420
1432
|
# @return [String]
|
|
1421
1433
|
attr_accessor :climate_preset_key
|
|
1422
|
-
# ID of the desired [thermostat](https://
|
|
1434
|
+
# ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
1423
1435
|
# @return [String]
|
|
1424
1436
|
attr_accessor :device_id
|
|
1425
|
-
# Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://
|
|
1437
|
+
# Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts.
|
|
1426
1438
|
# @return [Boolean, nil]
|
|
1427
1439
|
attr_accessor :is_override_allowed
|
|
1428
|
-
# Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://
|
|
1440
|
+
# Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). See also [Specifying Manual Override Permissions](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).
|
|
1429
1441
|
# @return [Integer, nil]
|
|
1430
1442
|
attr_accessor :max_override_period_minutes
|
|
1431
|
-
# User-friendly name to identify the [thermostat schedule](https://
|
|
1443
|
+
# User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1432
1444
|
# @return [String, nil]
|
|
1433
1445
|
attr_accessor :name
|
|
1434
|
-
# ID of the [thermostat schedule](https://
|
|
1446
|
+
# ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1435
1447
|
# @return [String]
|
|
1436
1448
|
attr_accessor :thermostat_schedule_id
|
|
1437
1449
|
# ID of the workspace that contains the thermostat schedule.
|
|
1438
1450
|
# @return [String]
|
|
1439
1451
|
attr_accessor :workspace_id
|
|
1440
|
-
# Date and time at which the [thermostat schedule](https://
|
|
1452
|
+
# Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
|
|
1441
1453
|
# @return [Time]
|
|
1442
1454
|
date_accessor :created_at
|
|
1443
|
-
# Date and time at which the [thermostat schedule](https://
|
|
1455
|
+
# Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
1444
1456
|
# @return [Time]
|
|
1445
1457
|
date_accessor :ends_at
|
|
1446
|
-
# Date and time at which the [thermostat schedule](https://
|
|
1458
|
+
# Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
1447
1459
|
# @return [Time]
|
|
1448
1460
|
date_accessor :starts_at
|
|
1449
1461
|
end
|
|
@@ -1467,16 +1479,16 @@ module Seam
|
|
|
1467
1479
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1468
1480
|
# @return [EcobeeMetadata, nil]
|
|
1469
1481
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1470
|
-
# Indicates whether the [climate preset](https://
|
|
1482
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
1471
1483
|
# @return [Boolean]
|
|
1472
1484
|
attr_accessor :can_delete
|
|
1473
|
-
# Indicates whether the [climate preset](https://
|
|
1485
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
1474
1486
|
# @return [Boolean]
|
|
1475
1487
|
attr_accessor :can_edit
|
|
1476
|
-
# Indicates whether the [climate preset](https://
|
|
1488
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
|
|
1477
1489
|
# @return [Boolean]
|
|
1478
1490
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1479
|
-
# Unique key to identify the [climate preset](https://
|
|
1491
|
+
# Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1480
1492
|
# @return [String]
|
|
1481
1493
|
attr_accessor :climate_preset_key
|
|
1482
1494
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1489,29 +1501,29 @@ module Seam
|
|
|
1489
1501
|
# - `occupied`
|
|
1490
1502
|
# - `unoccupied`
|
|
1491
1503
|
attr_accessor :climate_preset_mode
|
|
1492
|
-
# Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
1504
|
+
# 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).
|
|
1493
1505
|
# @return [Float, nil]
|
|
1494
1506
|
attr_accessor :cooling_set_point_celsius
|
|
1495
|
-
# Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
1507
|
+
# 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).
|
|
1496
1508
|
# @return [Float, nil]
|
|
1497
1509
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1498
|
-
# Display name for the [climate preset](https://
|
|
1510
|
+
# Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1499
1511
|
# @return [String]
|
|
1500
1512
|
attr_accessor :display_name
|
|
1501
|
-
# Desired [fan mode setting](https://
|
|
1513
|
+
# 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`.
|
|
1502
1514
|
# @return [String, nil]
|
|
1503
1515
|
# Known values:
|
|
1504
1516
|
# - `auto`
|
|
1505
1517
|
# - `on`
|
|
1506
1518
|
# - `circulate`
|
|
1507
1519
|
attr_accessor :fan_mode_setting
|
|
1508
|
-
# Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
1520
|
+
# 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).
|
|
1509
1521
|
# @return [Float, nil]
|
|
1510
1522
|
attr_accessor :heating_set_point_celsius
|
|
1511
|
-
# Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
1523
|
+
# 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).
|
|
1512
1524
|
# @return [Float, nil]
|
|
1513
1525
|
attr_accessor :heating_set_point_fahrenheit
|
|
1514
|
-
# Desired [HVAC mode](https://
|
|
1526
|
+
# 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`.
|
|
1515
1527
|
# @return [String, nil]
|
|
1516
1528
|
# Known values:
|
|
1517
1529
|
# - `off`
|
|
@@ -1520,11 +1532,11 @@ module Seam
|
|
|
1520
1532
|
# - `heat_cool`
|
|
1521
1533
|
# - `eco`
|
|
1522
1534
|
attr_accessor :hvac_mode_setting
|
|
1523
|
-
# Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
1535
|
+
# 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).
|
|
1524
1536
|
# @return [Boolean]
|
|
1525
1537
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1526
1538
|
attr_accessor :manual_override_allowed
|
|
1527
|
-
# User-friendly name to identify the [climate preset](https://
|
|
1539
|
+
# User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1528
1540
|
# @return [String, nil]
|
|
1529
1541
|
attr_accessor :name
|
|
1530
1542
|
end
|
|
@@ -1548,16 +1560,16 @@ module Seam
|
|
|
1548
1560
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1549
1561
|
# @return [EcobeeMetadata, nil]
|
|
1550
1562
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1551
|
-
# Indicates whether the [climate preset](https://
|
|
1563
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
1552
1564
|
# @return [Boolean, nil]
|
|
1553
1565
|
attr_accessor :can_delete
|
|
1554
|
-
# Indicates whether the [climate preset](https://
|
|
1566
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
1555
1567
|
# @return [Boolean, nil]
|
|
1556
1568
|
attr_accessor :can_edit
|
|
1557
|
-
# Indicates whether the [climate preset](https://
|
|
1569
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
|
|
1558
1570
|
# @return [Boolean, nil]
|
|
1559
1571
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1560
|
-
# Unique key to identify the [climate preset](https://
|
|
1572
|
+
# Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1561
1573
|
# @return [String, nil]
|
|
1562
1574
|
attr_accessor :climate_preset_key
|
|
1563
1575
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1570,29 +1582,29 @@ module Seam
|
|
|
1570
1582
|
# - `occupied`
|
|
1571
1583
|
# - `unoccupied`
|
|
1572
1584
|
attr_accessor :climate_preset_mode
|
|
1573
|
-
# Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
1585
|
+
# 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).
|
|
1574
1586
|
# @return [Float, nil]
|
|
1575
1587
|
attr_accessor :cooling_set_point_celsius
|
|
1576
|
-
# Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
1588
|
+
# 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).
|
|
1577
1589
|
# @return [Float, nil]
|
|
1578
1590
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1579
|
-
# Display name for the [climate preset](https://
|
|
1591
|
+
# Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1580
1592
|
# @return [String, nil]
|
|
1581
1593
|
attr_accessor :display_name
|
|
1582
|
-
# Desired [fan mode setting](https://
|
|
1594
|
+
# 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`.
|
|
1583
1595
|
# @return [String, nil]
|
|
1584
1596
|
# Known values:
|
|
1585
1597
|
# - `auto`
|
|
1586
1598
|
# - `on`
|
|
1587
1599
|
# - `circulate`
|
|
1588
1600
|
attr_accessor :fan_mode_setting
|
|
1589
|
-
# Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
1601
|
+
# 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).
|
|
1590
1602
|
# @return [Float, nil]
|
|
1591
1603
|
attr_accessor :heating_set_point_celsius
|
|
1592
|
-
# Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
1604
|
+
# 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).
|
|
1593
1605
|
# @return [Float, nil]
|
|
1594
1606
|
attr_accessor :heating_set_point_fahrenheit
|
|
1595
|
-
# Desired [HVAC mode](https://
|
|
1607
|
+
# 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`.
|
|
1596
1608
|
# @return [String, nil]
|
|
1597
1609
|
# Known values:
|
|
1598
1610
|
# - `off`
|
|
@@ -1601,11 +1613,11 @@ module Seam
|
|
|
1601
1613
|
# - `heat_cool`
|
|
1602
1614
|
# - `eco`
|
|
1603
1615
|
attr_accessor :hvac_mode_setting
|
|
1604
|
-
# Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
1616
|
+
# 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).
|
|
1605
1617
|
# @return [Boolean, nil]
|
|
1606
1618
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1607
1619
|
attr_accessor :manual_override_allowed
|
|
1608
|
-
# User-friendly name to identify the [climate preset](https://
|
|
1620
|
+
# User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1609
1621
|
# @return [String, nil]
|
|
1610
1622
|
attr_accessor :name
|
|
1611
1623
|
end
|
|
@@ -1629,16 +1641,16 @@ module Seam
|
|
|
1629
1641
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1630
1642
|
# @return [EcobeeMetadata, nil]
|
|
1631
1643
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1632
|
-
# Indicates whether the [climate preset](https://
|
|
1644
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
1633
1645
|
# @return [Boolean, nil]
|
|
1634
1646
|
attr_accessor :can_delete
|
|
1635
|
-
# Indicates whether the [climate preset](https://
|
|
1647
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
1636
1648
|
# @return [Boolean, nil]
|
|
1637
1649
|
attr_accessor :can_edit
|
|
1638
|
-
# Indicates whether the [climate preset](https://
|
|
1650
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be programmed in a thermostat daily program.
|
|
1639
1651
|
# @return [Boolean, nil]
|
|
1640
1652
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1641
|
-
# Unique key to identify the [climate preset](https://
|
|
1653
|
+
# Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1642
1654
|
# @return [String, nil]
|
|
1643
1655
|
attr_accessor :climate_preset_key
|
|
1644
1656
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1651,29 +1663,29 @@ module Seam
|
|
|
1651
1663
|
# - `occupied`
|
|
1652
1664
|
# - `unoccupied`
|
|
1653
1665
|
attr_accessor :climate_preset_mode
|
|
1654
|
-
# Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
1666
|
+
# 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).
|
|
1655
1667
|
# @return [Float, nil]
|
|
1656
1668
|
attr_accessor :cooling_set_point_celsius
|
|
1657
|
-
# Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
1669
|
+
# 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).
|
|
1658
1670
|
# @return [Float, nil]
|
|
1659
1671
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1660
|
-
# Display name for the [climate preset](https://
|
|
1672
|
+
# Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1661
1673
|
# @return [String, nil]
|
|
1662
1674
|
attr_accessor :display_name
|
|
1663
|
-
# Desired [fan mode setting](https://
|
|
1675
|
+
# 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`.
|
|
1664
1676
|
# @return [String, nil]
|
|
1665
1677
|
# Known values:
|
|
1666
1678
|
# - `auto`
|
|
1667
1679
|
# - `on`
|
|
1668
1680
|
# - `circulate`
|
|
1669
1681
|
attr_accessor :fan_mode_setting
|
|
1670
|
-
# Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
1682
|
+
# 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).
|
|
1671
1683
|
# @return [Float, nil]
|
|
1672
1684
|
attr_accessor :heating_set_point_celsius
|
|
1673
|
-
# Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
1685
|
+
# 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).
|
|
1674
1686
|
# @return [Float, nil]
|
|
1675
1687
|
attr_accessor :heating_set_point_fahrenheit
|
|
1676
|
-
# Desired [HVAC mode](https://
|
|
1688
|
+
# 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`.
|
|
1677
1689
|
# @return [String, nil]
|
|
1678
1690
|
# Known values:
|
|
1679
1691
|
# - `off`
|
|
@@ -1682,33 +1694,33 @@ module Seam
|
|
|
1682
1694
|
# - `heat_cool`
|
|
1683
1695
|
# - `eco`
|
|
1684
1696
|
attr_accessor :hvac_mode_setting
|
|
1685
|
-
# Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](https://
|
|
1697
|
+
# 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).
|
|
1686
1698
|
# @return [Boolean, nil]
|
|
1687
1699
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1688
1700
|
attr_accessor :manual_override_allowed
|
|
1689
|
-
# User-friendly name to identify the [climate preset](https://
|
|
1701
|
+
# User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1690
1702
|
# @return [String, nil]
|
|
1691
1703
|
attr_accessor :name
|
|
1692
1704
|
end
|
|
1693
1705
|
|
|
1694
1706
|
class TemperatureThreshold < BaseResource
|
|
1695
|
-
# Lower limit in °C within the current [temperature threshold](https://
|
|
1707
|
+
# Lower limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
1696
1708
|
# @return [Float, nil]
|
|
1697
1709
|
attr_accessor :lower_limit_celsius
|
|
1698
|
-
# Lower limit in °F within the current [temperature threshold](https://
|
|
1710
|
+
# Lower limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
1699
1711
|
# @return [Float, nil]
|
|
1700
1712
|
attr_accessor :lower_limit_fahrenheit
|
|
1701
|
-
# Upper limit in °C within the current [temperature threshold](https://
|
|
1713
|
+
# Upper limit in °C within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
1702
1714
|
# @return [Float, nil]
|
|
1703
1715
|
attr_accessor :upper_limit_celsius
|
|
1704
|
-
# Upper limit in °F within the current [temperature threshold](https://
|
|
1716
|
+
# Upper limit in °F within the current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
1705
1717
|
# @return [Float, nil]
|
|
1706
1718
|
attr_accessor :upper_limit_fahrenheit
|
|
1707
1719
|
end
|
|
1708
1720
|
|
|
1709
1721
|
class ThermostatDailyPrograms < BaseResource
|
|
1710
1722
|
class Periods < BaseResource
|
|
1711
|
-
# Key of the [climate preset](https://
|
|
1723
|
+
# Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.
|
|
1712
1724
|
# @return [String]
|
|
1713
1725
|
attr_accessor :climate_preset_key
|
|
1714
1726
|
# Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
@@ -1880,6 +1892,9 @@ module Seam
|
|
|
1880
1892
|
# Metadata for a tado° device.
|
|
1881
1893
|
# @return [TadoMetadata, nil]
|
|
1882
1894
|
resource_accessor :tado_metadata, TadoMetadata
|
|
1895
|
+
# Metadata for a Tapo camera.
|
|
1896
|
+
# @return [TapoMetadata, nil]
|
|
1897
|
+
resource_accessor :tapo_metadata, TapoMetadata
|
|
1883
1898
|
# Metadata for a Tedee device.
|
|
1884
1899
|
# @return [TedeeMetadata, nil]
|
|
1885
1900
|
resource_accessor :tedee_metadata, TedeeMetadata
|
|
@@ -1904,7 +1919,7 @@ module Seam
|
|
|
1904
1919
|
# Keypad battery status.
|
|
1905
1920
|
# @return [KeypadBattery, nil]
|
|
1906
1921
|
resource_accessor :keypad_battery, KeypadBattery
|
|
1907
|
-
# Active [thermostat schedule](https://
|
|
1922
|
+
# Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1908
1923
|
# @return [ActiveThermostatSchedule, nil]
|
|
1909
1924
|
resource_accessor :active_thermostat_schedule, ActiveThermostatSchedule
|
|
1910
1925
|
# Current climate setting.
|
|
@@ -1912,10 +1927,10 @@ module Seam
|
|
|
1912
1927
|
resource_accessor :current_climate_setting, CurrentClimateSetting
|
|
1913
1928
|
# @return [DefaultClimateSetting, nil]
|
|
1914
1929
|
resource_accessor :default_climate_setting, DefaultClimateSetting
|
|
1915
|
-
# Current [temperature threshold](https://
|
|
1930
|
+
# Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
1916
1931
|
# @return [TemperatureThreshold, nil]
|
|
1917
1932
|
resource_accessor :temperature_threshold, TemperatureThreshold
|
|
1918
|
-
# Current [weekly program](https://
|
|
1933
|
+
# Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
1919
1934
|
# @return [ThermostatWeeklyProgram, nil]
|
|
1920
1935
|
resource_accessor :thermostat_weekly_program, ThermostatWeeklyProgram
|
|
1921
1936
|
# Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
|
|
@@ -1927,10 +1942,10 @@ module Seam
|
|
|
1927
1942
|
# Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.
|
|
1928
1943
|
# @return [Array<OnlineTimeFrameOptions>]
|
|
1929
1944
|
resource_list_accessor :online_time_frame_options, OnlineTimeFrameOptions
|
|
1930
|
-
# Available [climate presets](https://
|
|
1945
|
+
# Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
|
|
1931
1946
|
# @return [Array<AvailableClimatePresets>]
|
|
1932
1947
|
resource_list_accessor :available_climate_presets, AvailableClimatePresets
|
|
1933
|
-
# Configured [daily programs](https://
|
|
1948
|
+
# Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
1934
1949
|
# @return [Array<ThermostatDailyPrograms>]
|
|
1935
1950
|
resource_list_accessor :thermostat_daily_programs, ThermostatDailyPrograms
|
|
1936
1951
|
# Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
|
|
@@ -1984,7 +1999,7 @@ module Seam
|
|
|
1984
1999
|
# Indicates whether automatic locking is enabled.
|
|
1985
2000
|
# @return [Boolean, nil]
|
|
1986
2001
|
attr_accessor :auto_lock_enabled
|
|
1987
|
-
# Indicates whether the [backup access code pool](https://
|
|
2002
|
+
# Indicates whether the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://www.seam.co/docs/api/devices/update).
|
|
1988
2003
|
# @return [Boolean, nil]
|
|
1989
2004
|
attr_accessor :backup_access_code_pool_enabled
|
|
1990
2005
|
# Indicates whether the door is open.
|
|
@@ -2002,10 +2017,10 @@ module Seam
|
|
|
2002
2017
|
# Supported code lengths for access codes.
|
|
2003
2018
|
# @return [Array<Float>]
|
|
2004
2019
|
attr_accessor :supported_code_lengths
|
|
2005
|
-
# Indicates whether the device supports a [backup access code pool](https://
|
|
2020
|
+
# Indicates whether the device supports a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
|
|
2006
2021
|
# @return [Boolean, nil]
|
|
2007
2022
|
attr_accessor :supports_backup_access_code_pool
|
|
2008
|
-
# ID of the active [thermostat schedule](https://
|
|
2023
|
+
# ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2009
2024
|
# @return [String, nil]
|
|
2010
2025
|
attr_accessor :active_thermostat_schedule_id
|
|
2011
2026
|
# Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
|
|
@@ -2034,7 +2049,7 @@ module Seam
|
|
|
2034
2049
|
# - `heat_cool`
|
|
2035
2050
|
# - `eco`
|
|
2036
2051
|
attr_accessor :available_hvac_mode_settings
|
|
2037
|
-
# Key of the [fallback climate preset](https://
|
|
2052
|
+
# Key of the [fallback climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.
|
|
2038
2053
|
# @return [String, nil]
|
|
2039
2054
|
attr_accessor :fallback_climate_preset_key
|
|
2040
2055
|
# @return [String, nil]
|
|
@@ -2056,16 +2071,16 @@ module Seam
|
|
|
2056
2071
|
# Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.
|
|
2057
2072
|
# @return [Boolean, nil]
|
|
2058
2073
|
attr_accessor :is_temporary_manual_override_active
|
|
2059
|
-
# Maximum [cooling set point](https://
|
|
2074
|
+
# Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2060
2075
|
# @return [Float, nil]
|
|
2061
2076
|
attr_accessor :max_cooling_set_point_celsius
|
|
2062
|
-
# Maximum [cooling set point](https://
|
|
2077
|
+
# Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2063
2078
|
# @return [Float, nil]
|
|
2064
2079
|
attr_accessor :max_cooling_set_point_fahrenheit
|
|
2065
|
-
# Maximum [heating set point](https://
|
|
2080
|
+
# Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2066
2081
|
# @return [Float, nil]
|
|
2067
2082
|
attr_accessor :max_heating_set_point_celsius
|
|
2068
|
-
# Maximum [heating set point](https://
|
|
2083
|
+
# Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2069
2084
|
# @return [Float, nil]
|
|
2070
2085
|
attr_accessor :max_heating_set_point_fahrenheit
|
|
2071
2086
|
# Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.
|
|
@@ -2074,22 +2089,22 @@ module Seam
|
|
|
2074
2089
|
# Maximum number of climate presets that the thermostat can support for weekly programming.
|
|
2075
2090
|
# @return [Float, nil]
|
|
2076
2091
|
attr_accessor :max_unique_climate_presets_per_thermostat_weekly_program
|
|
2077
|
-
# Minimum [cooling set point](https://
|
|
2092
|
+
# Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2078
2093
|
# @return [Float, nil]
|
|
2079
2094
|
attr_accessor :min_cooling_set_point_celsius
|
|
2080
|
-
# Minimum [cooling set point](https://
|
|
2095
|
+
# Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2081
2096
|
# @return [Float, nil]
|
|
2082
2097
|
attr_accessor :min_cooling_set_point_fahrenheit
|
|
2083
|
-
# Minimum [temperature difference](https://
|
|
2098
|
+
# Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.
|
|
2084
2099
|
# @return [Float, nil]
|
|
2085
2100
|
attr_accessor :min_heating_cooling_delta_celsius
|
|
2086
|
-
# Minimum [temperature difference](https://
|
|
2101
|
+
# Minimum [temperature difference](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.
|
|
2087
2102
|
# @return [Float, nil]
|
|
2088
2103
|
attr_accessor :min_heating_cooling_delta_fahrenheit
|
|
2089
|
-
# Minimum [heating set point](https://
|
|
2104
|
+
# Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2090
2105
|
# @return [Float, nil]
|
|
2091
2106
|
attr_accessor :min_heating_set_point_celsius
|
|
2092
|
-
# Minimum [heating set point](https://
|
|
2107
|
+
# Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2093
2108
|
# @return [Float, nil]
|
|
2094
2109
|
attr_accessor :min_heating_set_point_fahrenheit
|
|
2095
2110
|
# Reported relative humidity, as a value between 0 and 1, inclusive.
|
|
@@ -2683,7 +2698,7 @@ module Seam
|
|
|
2683
2698
|
# Indicates whether the lock supports unlocking with an access code.
|
|
2684
2699
|
# @return [Boolean, nil]
|
|
2685
2700
|
attr_accessor :can_unlock_with_code
|
|
2686
|
-
# Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://
|
|
2701
|
+
# Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
2687
2702
|
# @return [Array<String>]
|
|
2688
2703
|
# Known values:
|
|
2689
2704
|
# - `access_code`
|
|
@@ -2696,7 +2711,7 @@ module Seam
|
|
|
2696
2711
|
# Unique identifier for the account associated with the device.
|
|
2697
2712
|
# @return [String]
|
|
2698
2713
|
attr_accessor :connected_account_id
|
|
2699
|
-
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
2714
|
+
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
2700
2715
|
# @return [Hash{String => String, Boolean}]
|
|
2701
2716
|
attr_accessor :custom_metadata
|
|
2702
2717
|
# ID of the device.
|
|
@@ -2748,11 +2763,12 @@ module Seam
|
|
|
2748
2763
|
# - `ios_phone`
|
|
2749
2764
|
# - `android_phone`
|
|
2750
2765
|
# - `ring_camera`
|
|
2766
|
+
# - `tapo_camera`
|
|
2751
2767
|
attr_accessor :device_type
|
|
2752
2768
|
# Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
2753
2769
|
# @return [String]
|
|
2754
2770
|
attr_accessor :display_name
|
|
2755
|
-
# Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://
|
|
2771
|
+
# Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
2756
2772
|
# @return [TrueClass]
|
|
2757
2773
|
attr_accessor :is_managed
|
|
2758
2774
|
# Optional nickname to describe the device, settable through Seam.
|