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
|
@@ -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.
|
|
@@ -1425,37 +1425,37 @@ module Seam
|
|
|
1425
1425
|
date_accessor :created_at
|
|
1426
1426
|
end
|
|
1427
1427
|
|
|
1428
|
-
# 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).
|
|
1429
1429
|
# @return [Array<Errors>]
|
|
1430
1430
|
resource_list_accessor :errors, Errors
|
|
1431
|
-
# 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).
|
|
1432
1432
|
# @return [String]
|
|
1433
1433
|
attr_accessor :climate_preset_key
|
|
1434
|
-
# ID of the desired [thermostat](https://
|
|
1434
|
+
# ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
1435
1435
|
# @return [String]
|
|
1436
1436
|
attr_accessor :device_id
|
|
1437
|
-
# 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.
|
|
1438
1438
|
# @return [Boolean, nil]
|
|
1439
1439
|
attr_accessor :is_override_allowed
|
|
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://
|
|
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).
|
|
1441
1441
|
# @return [Integer, nil]
|
|
1442
1442
|
attr_accessor :max_override_period_minutes
|
|
1443
|
-
# 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).
|
|
1444
1444
|
# @return [String, nil]
|
|
1445
1445
|
attr_accessor :name
|
|
1446
|
-
# 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).
|
|
1447
1447
|
# @return [String]
|
|
1448
1448
|
attr_accessor :thermostat_schedule_id
|
|
1449
1449
|
# ID of the workspace that contains the thermostat schedule.
|
|
1450
1450
|
# @return [String]
|
|
1451
1451
|
attr_accessor :workspace_id
|
|
1452
|
-
# 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.
|
|
1453
1453
|
# @return [Time]
|
|
1454
1454
|
date_accessor :created_at
|
|
1455
|
-
# 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.
|
|
1456
1456
|
# @return [Time]
|
|
1457
1457
|
date_accessor :ends_at
|
|
1458
|
-
# 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.
|
|
1459
1459
|
# @return [Time]
|
|
1460
1460
|
date_accessor :starts_at
|
|
1461
1461
|
end
|
|
@@ -1479,16 +1479,16 @@ module Seam
|
|
|
1479
1479
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1480
1480
|
# @return [EcobeeMetadata, nil]
|
|
1481
1481
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1482
|
-
# 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.
|
|
1483
1483
|
# @return [Boolean]
|
|
1484
1484
|
attr_accessor :can_delete
|
|
1485
|
-
# 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.
|
|
1486
1486
|
# @return [Boolean]
|
|
1487
1487
|
attr_accessor :can_edit
|
|
1488
|
-
# 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.
|
|
1489
1489
|
# @return [Boolean]
|
|
1490
1490
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1491
|
-
# 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).
|
|
1492
1492
|
# @return [String]
|
|
1493
1493
|
attr_accessor :climate_preset_key
|
|
1494
1494
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1501,29 +1501,29 @@ module Seam
|
|
|
1501
1501
|
# - `occupied`
|
|
1502
1502
|
# - `unoccupied`
|
|
1503
1503
|
attr_accessor :climate_preset_mode
|
|
1504
|
-
# 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).
|
|
1505
1505
|
# @return [Float, nil]
|
|
1506
1506
|
attr_accessor :cooling_set_point_celsius
|
|
1507
|
-
# 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).
|
|
1508
1508
|
# @return [Float, nil]
|
|
1509
1509
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1510
|
-
# 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).
|
|
1511
1511
|
# @return [String]
|
|
1512
1512
|
attr_accessor :display_name
|
|
1513
|
-
# 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`.
|
|
1514
1514
|
# @return [String, nil]
|
|
1515
1515
|
# Known values:
|
|
1516
1516
|
# - `auto`
|
|
1517
1517
|
# - `on`
|
|
1518
1518
|
# - `circulate`
|
|
1519
1519
|
attr_accessor :fan_mode_setting
|
|
1520
|
-
# 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).
|
|
1521
1521
|
# @return [Float, nil]
|
|
1522
1522
|
attr_accessor :heating_set_point_celsius
|
|
1523
|
-
# 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).
|
|
1524
1524
|
# @return [Float, nil]
|
|
1525
1525
|
attr_accessor :heating_set_point_fahrenheit
|
|
1526
|
-
# 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`.
|
|
1527
1527
|
# @return [String, nil]
|
|
1528
1528
|
# Known values:
|
|
1529
1529
|
# - `off`
|
|
@@ -1532,11 +1532,11 @@ module Seam
|
|
|
1532
1532
|
# - `heat_cool`
|
|
1533
1533
|
# - `eco`
|
|
1534
1534
|
attr_accessor :hvac_mode_setting
|
|
1535
|
-
# 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).
|
|
1536
1536
|
# @return [Boolean]
|
|
1537
1537
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1538
1538
|
attr_accessor :manual_override_allowed
|
|
1539
|
-
# 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).
|
|
1540
1540
|
# @return [String, nil]
|
|
1541
1541
|
attr_accessor :name
|
|
1542
1542
|
end
|
|
@@ -1560,16 +1560,16 @@ module Seam
|
|
|
1560
1560
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1561
1561
|
# @return [EcobeeMetadata, nil]
|
|
1562
1562
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1563
|
-
# 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.
|
|
1564
1564
|
# @return [Boolean, nil]
|
|
1565
1565
|
attr_accessor :can_delete
|
|
1566
|
-
# 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.
|
|
1567
1567
|
# @return [Boolean, nil]
|
|
1568
1568
|
attr_accessor :can_edit
|
|
1569
|
-
# 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.
|
|
1570
1570
|
# @return [Boolean, nil]
|
|
1571
1571
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1572
|
-
# 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).
|
|
1573
1573
|
# @return [String, nil]
|
|
1574
1574
|
attr_accessor :climate_preset_key
|
|
1575
1575
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1582,29 +1582,29 @@ module Seam
|
|
|
1582
1582
|
# - `occupied`
|
|
1583
1583
|
# - `unoccupied`
|
|
1584
1584
|
attr_accessor :climate_preset_mode
|
|
1585
|
-
# 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).
|
|
1586
1586
|
# @return [Float, nil]
|
|
1587
1587
|
attr_accessor :cooling_set_point_celsius
|
|
1588
|
-
# 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).
|
|
1589
1589
|
# @return [Float, nil]
|
|
1590
1590
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1591
|
-
# 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).
|
|
1592
1592
|
# @return [String, nil]
|
|
1593
1593
|
attr_accessor :display_name
|
|
1594
|
-
# 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`.
|
|
1595
1595
|
# @return [String, nil]
|
|
1596
1596
|
# Known values:
|
|
1597
1597
|
# - `auto`
|
|
1598
1598
|
# - `on`
|
|
1599
1599
|
# - `circulate`
|
|
1600
1600
|
attr_accessor :fan_mode_setting
|
|
1601
|
-
# 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).
|
|
1602
1602
|
# @return [Float, nil]
|
|
1603
1603
|
attr_accessor :heating_set_point_celsius
|
|
1604
|
-
# 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).
|
|
1605
1605
|
# @return [Float, nil]
|
|
1606
1606
|
attr_accessor :heating_set_point_fahrenheit
|
|
1607
|
-
# 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`.
|
|
1608
1608
|
# @return [String, nil]
|
|
1609
1609
|
# Known values:
|
|
1610
1610
|
# - `off`
|
|
@@ -1613,11 +1613,11 @@ module Seam
|
|
|
1613
1613
|
# - `heat_cool`
|
|
1614
1614
|
# - `eco`
|
|
1615
1615
|
attr_accessor :hvac_mode_setting
|
|
1616
|
-
# 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).
|
|
1617
1617
|
# @return [Boolean, nil]
|
|
1618
1618
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1619
1619
|
attr_accessor :manual_override_allowed
|
|
1620
|
-
# 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).
|
|
1621
1621
|
# @return [String, nil]
|
|
1622
1622
|
attr_accessor :name
|
|
1623
1623
|
end
|
|
@@ -1641,16 +1641,16 @@ module Seam
|
|
|
1641
1641
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1642
1642
|
# @return [EcobeeMetadata, nil]
|
|
1643
1643
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1644
|
-
# 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.
|
|
1645
1645
|
# @return [Boolean, nil]
|
|
1646
1646
|
attr_accessor :can_delete
|
|
1647
|
-
# 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.
|
|
1648
1648
|
# @return [Boolean, nil]
|
|
1649
1649
|
attr_accessor :can_edit
|
|
1650
|
-
# 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.
|
|
1651
1651
|
# @return [Boolean, nil]
|
|
1652
1652
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1653
|
-
# 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).
|
|
1654
1654
|
# @return [String, nil]
|
|
1655
1655
|
attr_accessor :climate_preset_key
|
|
1656
1656
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1663,29 +1663,29 @@ module Seam
|
|
|
1663
1663
|
# - `occupied`
|
|
1664
1664
|
# - `unoccupied`
|
|
1665
1665
|
attr_accessor :climate_preset_mode
|
|
1666
|
-
# 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).
|
|
1667
1667
|
# @return [Float, nil]
|
|
1668
1668
|
attr_accessor :cooling_set_point_celsius
|
|
1669
|
-
# 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).
|
|
1670
1670
|
# @return [Float, nil]
|
|
1671
1671
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1672
|
-
# 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).
|
|
1673
1673
|
# @return [String, nil]
|
|
1674
1674
|
attr_accessor :display_name
|
|
1675
|
-
# 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`.
|
|
1676
1676
|
# @return [String, nil]
|
|
1677
1677
|
# Known values:
|
|
1678
1678
|
# - `auto`
|
|
1679
1679
|
# - `on`
|
|
1680
1680
|
# - `circulate`
|
|
1681
1681
|
attr_accessor :fan_mode_setting
|
|
1682
|
-
# 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).
|
|
1683
1683
|
# @return [Float, nil]
|
|
1684
1684
|
attr_accessor :heating_set_point_celsius
|
|
1685
|
-
# 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).
|
|
1686
1686
|
# @return [Float, nil]
|
|
1687
1687
|
attr_accessor :heating_set_point_fahrenheit
|
|
1688
|
-
# 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`.
|
|
1689
1689
|
# @return [String, nil]
|
|
1690
1690
|
# Known values:
|
|
1691
1691
|
# - `off`
|
|
@@ -1694,33 +1694,33 @@ module Seam
|
|
|
1694
1694
|
# - `heat_cool`
|
|
1695
1695
|
# - `eco`
|
|
1696
1696
|
attr_accessor :hvac_mode_setting
|
|
1697
|
-
# 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).
|
|
1698
1698
|
# @return [Boolean, nil]
|
|
1699
1699
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1700
1700
|
attr_accessor :manual_override_allowed
|
|
1701
|
-
# 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).
|
|
1702
1702
|
# @return [String, nil]
|
|
1703
1703
|
attr_accessor :name
|
|
1704
1704
|
end
|
|
1705
1705
|
|
|
1706
1706
|
class TemperatureThreshold < BaseResource
|
|
1707
|
-
# 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.
|
|
1708
1708
|
# @return [Float, nil]
|
|
1709
1709
|
attr_accessor :lower_limit_celsius
|
|
1710
|
-
# 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.
|
|
1711
1711
|
# @return [Float, nil]
|
|
1712
1712
|
attr_accessor :lower_limit_fahrenheit
|
|
1713
|
-
# 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.
|
|
1714
1714
|
# @return [Float, nil]
|
|
1715
1715
|
attr_accessor :upper_limit_celsius
|
|
1716
|
-
# 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.
|
|
1717
1717
|
# @return [Float, nil]
|
|
1718
1718
|
attr_accessor :upper_limit_fahrenheit
|
|
1719
1719
|
end
|
|
1720
1720
|
|
|
1721
1721
|
class ThermostatDailyPrograms < BaseResource
|
|
1722
1722
|
class Periods < BaseResource
|
|
1723
|
-
# 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`.
|
|
1724
1724
|
# @return [String]
|
|
1725
1725
|
attr_accessor :climate_preset_key
|
|
1726
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.
|
|
@@ -1919,7 +1919,7 @@ module Seam
|
|
|
1919
1919
|
# Keypad battery status.
|
|
1920
1920
|
# @return [KeypadBattery, nil]
|
|
1921
1921
|
resource_accessor :keypad_battery, KeypadBattery
|
|
1922
|
-
# Active [thermostat schedule](https://
|
|
1922
|
+
# Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1923
1923
|
# @return [ActiveThermostatSchedule, nil]
|
|
1924
1924
|
resource_accessor :active_thermostat_schedule, ActiveThermostatSchedule
|
|
1925
1925
|
# Current climate setting.
|
|
@@ -1927,10 +1927,10 @@ module Seam
|
|
|
1927
1927
|
resource_accessor :current_climate_setting, CurrentClimateSetting
|
|
1928
1928
|
# @return [DefaultClimateSetting, nil]
|
|
1929
1929
|
resource_accessor :default_climate_setting, DefaultClimateSetting
|
|
1930
|
-
# 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.
|
|
1931
1931
|
# @return [TemperatureThreshold, nil]
|
|
1932
1932
|
resource_accessor :temperature_threshold, TemperatureThreshold
|
|
1933
|
-
# Current [weekly program](https://
|
|
1933
|
+
# Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
1934
1934
|
# @return [ThermostatWeeklyProgram, nil]
|
|
1935
1935
|
resource_accessor :thermostat_weekly_program, ThermostatWeeklyProgram
|
|
1936
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.
|
|
@@ -1942,10 +1942,10 @@ module Seam
|
|
|
1942
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.
|
|
1943
1943
|
# @return [Array<OnlineTimeFrameOptions>]
|
|
1944
1944
|
resource_list_accessor :online_time_frame_options, OnlineTimeFrameOptions
|
|
1945
|
-
# Available [climate presets](https://
|
|
1945
|
+
# Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
|
|
1946
1946
|
# @return [Array<AvailableClimatePresets>]
|
|
1947
1947
|
resource_list_accessor :available_climate_presets, AvailableClimatePresets
|
|
1948
|
-
# Configured [daily programs](https://
|
|
1948
|
+
# Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
1949
1949
|
# @return [Array<ThermostatDailyPrograms>]
|
|
1950
1950
|
resource_list_accessor :thermostat_daily_programs, ThermostatDailyPrograms
|
|
1951
1951
|
# Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
|
|
@@ -1999,7 +1999,7 @@ module Seam
|
|
|
1999
1999
|
# Indicates whether automatic locking is enabled.
|
|
2000
2000
|
# @return [Boolean, nil]
|
|
2001
2001
|
attr_accessor :auto_lock_enabled
|
|
2002
|
-
# 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).
|
|
2003
2003
|
# @return [Boolean, nil]
|
|
2004
2004
|
attr_accessor :backup_access_code_pool_enabled
|
|
2005
2005
|
# Indicates whether the door is open.
|
|
@@ -2017,10 +2017,10 @@ module Seam
|
|
|
2017
2017
|
# Supported code lengths for access codes.
|
|
2018
2018
|
# @return [Array<Float>]
|
|
2019
2019
|
attr_accessor :supported_code_lengths
|
|
2020
|
-
# 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).
|
|
2021
2021
|
# @return [Boolean, nil]
|
|
2022
2022
|
attr_accessor :supports_backup_access_code_pool
|
|
2023
|
-
# 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).
|
|
2024
2024
|
# @return [String, nil]
|
|
2025
2025
|
attr_accessor :active_thermostat_schedule_id
|
|
2026
2026
|
# Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
|
|
@@ -2049,7 +2049,7 @@ module Seam
|
|
|
2049
2049
|
# - `heat_cool`
|
|
2050
2050
|
# - `eco`
|
|
2051
2051
|
attr_accessor :available_hvac_mode_settings
|
|
2052
|
-
# 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.
|
|
2053
2053
|
# @return [String, nil]
|
|
2054
2054
|
attr_accessor :fallback_climate_preset_key
|
|
2055
2055
|
# @return [String, nil]
|
|
@@ -2071,16 +2071,16 @@ module Seam
|
|
|
2071
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`.
|
|
2072
2072
|
# @return [Boolean, nil]
|
|
2073
2073
|
attr_accessor :is_temporary_manual_override_active
|
|
2074
|
-
# 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.
|
|
2075
2075
|
# @return [Float, nil]
|
|
2076
2076
|
attr_accessor :max_cooling_set_point_celsius
|
|
2077
|
-
# 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.
|
|
2078
2078
|
# @return [Float, nil]
|
|
2079
2079
|
attr_accessor :max_cooling_set_point_fahrenheit
|
|
2080
|
-
# 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.
|
|
2081
2081
|
# @return [Float, nil]
|
|
2082
2082
|
attr_accessor :max_heating_set_point_celsius
|
|
2083
|
-
# 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.
|
|
2084
2084
|
# @return [Float, nil]
|
|
2085
2085
|
attr_accessor :max_heating_set_point_fahrenheit
|
|
2086
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.
|
|
@@ -2089,22 +2089,22 @@ module Seam
|
|
|
2089
2089
|
# Maximum number of climate presets that the thermostat can support for weekly programming.
|
|
2090
2090
|
# @return [Float, nil]
|
|
2091
2091
|
attr_accessor :max_unique_climate_presets_per_thermostat_weekly_program
|
|
2092
|
-
# 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.
|
|
2093
2093
|
# @return [Float, nil]
|
|
2094
2094
|
attr_accessor :min_cooling_set_point_celsius
|
|
2095
|
-
# 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.
|
|
2096
2096
|
# @return [Float, nil]
|
|
2097
2097
|
attr_accessor :min_cooling_set_point_fahrenheit
|
|
2098
|
-
# 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.
|
|
2099
2099
|
# @return [Float, nil]
|
|
2100
2100
|
attr_accessor :min_heating_cooling_delta_celsius
|
|
2101
|
-
# 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.
|
|
2102
2102
|
# @return [Float, nil]
|
|
2103
2103
|
attr_accessor :min_heating_cooling_delta_fahrenheit
|
|
2104
|
-
# 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.
|
|
2105
2105
|
# @return [Float, nil]
|
|
2106
2106
|
attr_accessor :min_heating_set_point_celsius
|
|
2107
|
-
# 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.
|
|
2108
2108
|
# @return [Float, nil]
|
|
2109
2109
|
attr_accessor :min_heating_set_point_fahrenheit
|
|
2110
2110
|
# Reported relative humidity, as a value between 0 and 1, inclusive.
|
|
@@ -2698,7 +2698,7 @@ module Seam
|
|
|
2698
2698
|
# Indicates whether the lock supports unlocking with an access code.
|
|
2699
2699
|
# @return [Boolean, nil]
|
|
2700
2700
|
attr_accessor :can_unlock_with_code
|
|
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://
|
|
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).
|
|
2702
2702
|
# @return [Array<String>]
|
|
2703
2703
|
# Known values:
|
|
2704
2704
|
# - `access_code`
|
|
@@ -2711,7 +2711,7 @@ module Seam
|
|
|
2711
2711
|
# Unique identifier for the account associated with the device.
|
|
2712
2712
|
# @return [String]
|
|
2713
2713
|
attr_accessor :connected_account_id
|
|
2714
|
-
# 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.
|
|
2715
2715
|
# @return [Hash{String => String, Boolean}]
|
|
2716
2716
|
attr_accessor :custom_metadata
|
|
2717
2717
|
# ID of the device.
|
|
@@ -2768,7 +2768,7 @@ module Seam
|
|
|
2768
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.
|
|
2769
2769
|
# @return [String]
|
|
2770
2770
|
attr_accessor :display_name
|
|
2771
|
-
# 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).
|
|
2772
2772
|
# @return [TrueClass]
|
|
2773
2773
|
attr_accessor :is_managed
|
|
2774
2774
|
# Optional nickname to describe the device, settable through Seam.
|