seam 2.157.0 → 2.159.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 +19 -19
- 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 +106 -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 +16 -16
- 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.
|
|
@@ -481,6 +481,24 @@ module Seam
|
|
|
481
481
|
attr_accessor :time_zone
|
|
482
482
|
end
|
|
483
483
|
|
|
484
|
+
class ArloMetadata < BaseResource
|
|
485
|
+
# Device ID reported by Arlo.
|
|
486
|
+
# @return [String, nil]
|
|
487
|
+
attr_accessor :device_id
|
|
488
|
+
# Device name reported by Arlo.
|
|
489
|
+
# @return [String, nil]
|
|
490
|
+
attr_accessor :device_name
|
|
491
|
+
# Firmware version reported by Arlo.
|
|
492
|
+
# @return [String, nil]
|
|
493
|
+
attr_accessor :firmware_version
|
|
494
|
+
# Hardware version reported by Arlo.
|
|
495
|
+
# @return [String, nil]
|
|
496
|
+
attr_accessor :hardware_version
|
|
497
|
+
# Model ID reported by Arlo.
|
|
498
|
+
# @return [String, nil]
|
|
499
|
+
attr_accessor :model_id
|
|
500
|
+
end
|
|
501
|
+
|
|
484
502
|
class AssaAbloyVostioMetadata < BaseResource
|
|
485
503
|
# Encoder name for an ASSA ABLOY Vostio system.
|
|
486
504
|
# @return [String, nil]
|
|
@@ -1425,37 +1443,37 @@ module Seam
|
|
|
1425
1443
|
date_accessor :created_at
|
|
1426
1444
|
end
|
|
1427
1445
|
|
|
1428
|
-
# Errors associated with the [thermostat schedule](https://
|
|
1446
|
+
# Errors associated with the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1429
1447
|
# @return [Array<Errors>]
|
|
1430
1448
|
resource_list_accessor :errors, Errors
|
|
1431
|
-
# Key of the [climate preset](https://
|
|
1449
|
+
# 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
1450
|
# @return [String]
|
|
1433
1451
|
attr_accessor :climate_preset_key
|
|
1434
|
-
# ID of the desired [thermostat](https://
|
|
1452
|
+
# ID of the desired [thermostat](https://www.seam.co/docs/capability-guides/thermostats) device.
|
|
1435
1453
|
# @return [String]
|
|
1436
1454
|
attr_accessor :device_id
|
|
1437
|
-
# Indicates whether a person at the thermostat can change the thermostat's settings after the [thermostat schedule](https://
|
|
1455
|
+
# 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
1456
|
# @return [Boolean, nil]
|
|
1439
1457
|
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://
|
|
1458
|
+
# 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
1459
|
# @return [Integer, nil]
|
|
1442
1460
|
attr_accessor :max_override_period_minutes
|
|
1443
|
-
# User-friendly name to identify the [thermostat schedule](https://
|
|
1461
|
+
# User-friendly name to identify the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1444
1462
|
# @return [String, nil]
|
|
1445
1463
|
attr_accessor :name
|
|
1446
|
-
# ID of the [thermostat schedule](https://
|
|
1464
|
+
# ID of the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1447
1465
|
# @return [String]
|
|
1448
1466
|
attr_accessor :thermostat_schedule_id
|
|
1449
1467
|
# ID of the workspace that contains the thermostat schedule.
|
|
1450
1468
|
# @return [String]
|
|
1451
1469
|
attr_accessor :workspace_id
|
|
1452
|
-
# Date and time at which the [thermostat schedule](https://
|
|
1470
|
+
# Date and time at which the [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) was created.
|
|
1453
1471
|
# @return [Time]
|
|
1454
1472
|
date_accessor :created_at
|
|
1455
|
-
# Date and time at which the [thermostat schedule](https://
|
|
1473
|
+
# 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
1474
|
# @return [Time]
|
|
1457
1475
|
date_accessor :ends_at
|
|
1458
|
-
# Date and time at which the [thermostat schedule](https://
|
|
1476
|
+
# 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
1477
|
# @return [Time]
|
|
1460
1478
|
date_accessor :starts_at
|
|
1461
1479
|
end
|
|
@@ -1479,16 +1497,16 @@ module Seam
|
|
|
1479
1497
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1480
1498
|
# @return [EcobeeMetadata, nil]
|
|
1481
1499
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1482
|
-
# Indicates whether the [climate preset](https://
|
|
1500
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
1483
1501
|
# @return [Boolean]
|
|
1484
1502
|
attr_accessor :can_delete
|
|
1485
|
-
# Indicates whether the [climate preset](https://
|
|
1503
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
1486
1504
|
# @return [Boolean]
|
|
1487
1505
|
attr_accessor :can_edit
|
|
1488
|
-
# Indicates whether the [climate preset](https://
|
|
1506
|
+
# 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
1507
|
# @return [Boolean]
|
|
1490
1508
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1491
|
-
# Unique key to identify the [climate preset](https://
|
|
1509
|
+
# Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1492
1510
|
# @return [String]
|
|
1493
1511
|
attr_accessor :climate_preset_key
|
|
1494
1512
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1501,29 +1519,29 @@ module Seam
|
|
|
1501
1519
|
# - `occupied`
|
|
1502
1520
|
# - `unoccupied`
|
|
1503
1521
|
attr_accessor :climate_preset_mode
|
|
1504
|
-
# Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
1522
|
+
# 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
1523
|
# @return [Float, nil]
|
|
1506
1524
|
attr_accessor :cooling_set_point_celsius
|
|
1507
|
-
# Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
1525
|
+
# 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
1526
|
# @return [Float, nil]
|
|
1509
1527
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1510
|
-
# Display name for the [climate preset](https://
|
|
1528
|
+
# Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1511
1529
|
# @return [String]
|
|
1512
1530
|
attr_accessor :display_name
|
|
1513
|
-
# Desired [fan mode setting](https://
|
|
1531
|
+
# 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
1532
|
# @return [String, nil]
|
|
1515
1533
|
# Known values:
|
|
1516
1534
|
# - `auto`
|
|
1517
1535
|
# - `on`
|
|
1518
1536
|
# - `circulate`
|
|
1519
1537
|
attr_accessor :fan_mode_setting
|
|
1520
|
-
# Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
1538
|
+
# 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
1539
|
# @return [Float, nil]
|
|
1522
1540
|
attr_accessor :heating_set_point_celsius
|
|
1523
|
-
# Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
1541
|
+
# 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
1542
|
# @return [Float, nil]
|
|
1525
1543
|
attr_accessor :heating_set_point_fahrenheit
|
|
1526
|
-
# Desired [HVAC mode](https://
|
|
1544
|
+
# 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
1545
|
# @return [String, nil]
|
|
1528
1546
|
# Known values:
|
|
1529
1547
|
# - `off`
|
|
@@ -1532,11 +1550,11 @@ module Seam
|
|
|
1532
1550
|
# - `heat_cool`
|
|
1533
1551
|
# - `eco`
|
|
1534
1552
|
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://
|
|
1553
|
+
# 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
1554
|
# @return [Boolean]
|
|
1537
1555
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1538
1556
|
attr_accessor :manual_override_allowed
|
|
1539
|
-
# User-friendly name to identify the [climate preset](https://
|
|
1557
|
+
# User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1540
1558
|
# @return [String, nil]
|
|
1541
1559
|
attr_accessor :name
|
|
1542
1560
|
end
|
|
@@ -1560,16 +1578,16 @@ module Seam
|
|
|
1560
1578
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1561
1579
|
# @return [EcobeeMetadata, nil]
|
|
1562
1580
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1563
|
-
# Indicates whether the [climate preset](https://
|
|
1581
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
1564
1582
|
# @return [Boolean, nil]
|
|
1565
1583
|
attr_accessor :can_delete
|
|
1566
|
-
# Indicates whether the [climate preset](https://
|
|
1584
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
1567
1585
|
# @return [Boolean, nil]
|
|
1568
1586
|
attr_accessor :can_edit
|
|
1569
|
-
# Indicates whether the [climate preset](https://
|
|
1587
|
+
# 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
1588
|
# @return [Boolean, nil]
|
|
1571
1589
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1572
|
-
# Unique key to identify the [climate preset](https://
|
|
1590
|
+
# Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1573
1591
|
# @return [String, nil]
|
|
1574
1592
|
attr_accessor :climate_preset_key
|
|
1575
1593
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1582,29 +1600,29 @@ module Seam
|
|
|
1582
1600
|
# - `occupied`
|
|
1583
1601
|
# - `unoccupied`
|
|
1584
1602
|
attr_accessor :climate_preset_mode
|
|
1585
|
-
# Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
1603
|
+
# 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
1604
|
# @return [Float, nil]
|
|
1587
1605
|
attr_accessor :cooling_set_point_celsius
|
|
1588
|
-
# Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
1606
|
+
# 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
1607
|
# @return [Float, nil]
|
|
1590
1608
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1591
|
-
# Display name for the [climate preset](https://
|
|
1609
|
+
# Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1592
1610
|
# @return [String, nil]
|
|
1593
1611
|
attr_accessor :display_name
|
|
1594
|
-
# Desired [fan mode setting](https://
|
|
1612
|
+
# 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
1613
|
# @return [String, nil]
|
|
1596
1614
|
# Known values:
|
|
1597
1615
|
# - `auto`
|
|
1598
1616
|
# - `on`
|
|
1599
1617
|
# - `circulate`
|
|
1600
1618
|
attr_accessor :fan_mode_setting
|
|
1601
|
-
# Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
1619
|
+
# 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
1620
|
# @return [Float, nil]
|
|
1603
1621
|
attr_accessor :heating_set_point_celsius
|
|
1604
|
-
# Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
1622
|
+
# 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
1623
|
# @return [Float, nil]
|
|
1606
1624
|
attr_accessor :heating_set_point_fahrenheit
|
|
1607
|
-
# Desired [HVAC mode](https://
|
|
1625
|
+
# 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
1626
|
# @return [String, nil]
|
|
1609
1627
|
# Known values:
|
|
1610
1628
|
# - `off`
|
|
@@ -1613,11 +1631,11 @@ module Seam
|
|
|
1613
1631
|
# - `heat_cool`
|
|
1614
1632
|
# - `eco`
|
|
1615
1633
|
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://
|
|
1634
|
+
# 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
1635
|
# @return [Boolean, nil]
|
|
1618
1636
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1619
1637
|
attr_accessor :manual_override_allowed
|
|
1620
|
-
# User-friendly name to identify the [climate preset](https://
|
|
1638
|
+
# User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1621
1639
|
# @return [String, nil]
|
|
1622
1640
|
attr_accessor :name
|
|
1623
1641
|
end
|
|
@@ -1641,16 +1659,16 @@ module Seam
|
|
|
1641
1659
|
# Metadata specific to the Ecobee climate, if applicable.
|
|
1642
1660
|
# @return [EcobeeMetadata, nil]
|
|
1643
1661
|
resource_accessor :ecobee_metadata, EcobeeMetadata
|
|
1644
|
-
# Indicates whether the [climate preset](https://
|
|
1662
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.
|
|
1645
1663
|
# @return [Boolean, nil]
|
|
1646
1664
|
attr_accessor :can_delete
|
|
1647
|
-
# Indicates whether the [climate preset](https://
|
|
1665
|
+
# Indicates whether the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) key can be edited.
|
|
1648
1666
|
# @return [Boolean, nil]
|
|
1649
1667
|
attr_accessor :can_edit
|
|
1650
|
-
# Indicates whether the [climate preset](https://
|
|
1668
|
+
# 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
1669
|
# @return [Boolean, nil]
|
|
1652
1670
|
attr_accessor :can_use_with_thermostat_daily_programs
|
|
1653
|
-
# Unique key to identify the [climate preset](https://
|
|
1671
|
+
# Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1654
1672
|
# @return [String, nil]
|
|
1655
1673
|
attr_accessor :climate_preset_key
|
|
1656
1674
|
# The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
@@ -1663,29 +1681,29 @@ module Seam
|
|
|
1663
1681
|
# - `occupied`
|
|
1664
1682
|
# - `unoccupied`
|
|
1665
1683
|
attr_accessor :climate_preset_mode
|
|
1666
|
-
# Temperature to which the thermostat should cool (in °C). See also [Set Points](https://
|
|
1684
|
+
# 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
1685
|
# @return [Float, nil]
|
|
1668
1686
|
attr_accessor :cooling_set_point_celsius
|
|
1669
|
-
# Temperature to which the thermostat should cool (in °F). See also [Set Points](https://
|
|
1687
|
+
# 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
1688
|
# @return [Float, nil]
|
|
1671
1689
|
attr_accessor :cooling_set_point_fahrenheit
|
|
1672
|
-
# Display name for the [climate preset](https://
|
|
1690
|
+
# Display name for the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1673
1691
|
# @return [String, nil]
|
|
1674
1692
|
attr_accessor :display_name
|
|
1675
|
-
# Desired [fan mode setting](https://
|
|
1693
|
+
# 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
1694
|
# @return [String, nil]
|
|
1677
1695
|
# Known values:
|
|
1678
1696
|
# - `auto`
|
|
1679
1697
|
# - `on`
|
|
1680
1698
|
# - `circulate`
|
|
1681
1699
|
attr_accessor :fan_mode_setting
|
|
1682
|
-
# Temperature to which the thermostat should heat (in °C). See also [Set Points](https://
|
|
1700
|
+
# 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
1701
|
# @return [Float, nil]
|
|
1684
1702
|
attr_accessor :heating_set_point_celsius
|
|
1685
|
-
# Temperature to which the thermostat should heat (in °F). See also [Set Points](https://
|
|
1703
|
+
# 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
1704
|
# @return [Float, nil]
|
|
1687
1705
|
attr_accessor :heating_set_point_fahrenheit
|
|
1688
|
-
# Desired [HVAC mode](https://
|
|
1706
|
+
# 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
1707
|
# @return [String, nil]
|
|
1690
1708
|
# Known values:
|
|
1691
1709
|
# - `off`
|
|
@@ -1694,33 +1712,33 @@ module Seam
|
|
|
1694
1712
|
# - `heat_cool`
|
|
1695
1713
|
# - `eco`
|
|
1696
1714
|
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://
|
|
1715
|
+
# 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
1716
|
# @return [Boolean, nil]
|
|
1699
1717
|
# @deprecated Use 'thermostat_schedule.is_override_allowed'
|
|
1700
1718
|
attr_accessor :manual_override_allowed
|
|
1701
|
-
# User-friendly name to identify the [climate preset](https://
|
|
1719
|
+
# User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets).
|
|
1702
1720
|
# @return [String, nil]
|
|
1703
1721
|
attr_accessor :name
|
|
1704
1722
|
end
|
|
1705
1723
|
|
|
1706
1724
|
class TemperatureThreshold < BaseResource
|
|
1707
|
-
# Lower limit in °C within the current [temperature threshold](https://
|
|
1725
|
+
# 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
1726
|
# @return [Float, nil]
|
|
1709
1727
|
attr_accessor :lower_limit_celsius
|
|
1710
|
-
# Lower limit in °F within the current [temperature threshold](https://
|
|
1728
|
+
# 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
1729
|
# @return [Float, nil]
|
|
1712
1730
|
attr_accessor :lower_limit_fahrenheit
|
|
1713
|
-
# Upper limit in °C within the current [temperature threshold](https://
|
|
1731
|
+
# 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
1732
|
# @return [Float, nil]
|
|
1715
1733
|
attr_accessor :upper_limit_celsius
|
|
1716
|
-
# Upper limit in °F within the current [temperature threshold](https://
|
|
1734
|
+
# 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
1735
|
# @return [Float, nil]
|
|
1718
1736
|
attr_accessor :upper_limit_fahrenheit
|
|
1719
1737
|
end
|
|
1720
1738
|
|
|
1721
1739
|
class ThermostatDailyPrograms < BaseResource
|
|
1722
1740
|
class Periods < BaseResource
|
|
1723
|
-
# Key of the [climate preset](https://
|
|
1741
|
+
# 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
1742
|
# @return [String]
|
|
1725
1743
|
attr_accessor :climate_preset_key
|
|
1726
1744
|
# Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
|
|
@@ -1799,6 +1817,9 @@ module Seam
|
|
|
1799
1817
|
# Metadata for an Aqara device.
|
|
1800
1818
|
# @return [AqaraMetadata, nil]
|
|
1801
1819
|
resource_accessor :aqara_metadata, AqaraMetadata
|
|
1820
|
+
# Metadata for an Arlo camera.
|
|
1821
|
+
# @return [ArloMetadata, nil]
|
|
1822
|
+
resource_accessor :arlo_metadata, ArloMetadata
|
|
1802
1823
|
# Metadata for an ASSA ABLOY Vostio system.
|
|
1803
1824
|
# @return [AssaAbloyVostioMetadata, nil]
|
|
1804
1825
|
resource_accessor :assa_abloy_vostio_metadata, AssaAbloyVostioMetadata
|
|
@@ -1919,7 +1940,7 @@ module Seam
|
|
|
1919
1940
|
# Keypad battery status.
|
|
1920
1941
|
# @return [KeypadBattery, nil]
|
|
1921
1942
|
resource_accessor :keypad_battery, KeypadBattery
|
|
1922
|
-
# Active [thermostat schedule](https://
|
|
1943
|
+
# Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1923
1944
|
# @return [ActiveThermostatSchedule, nil]
|
|
1924
1945
|
resource_accessor :active_thermostat_schedule, ActiveThermostatSchedule
|
|
1925
1946
|
# Current climate setting.
|
|
@@ -1927,10 +1948,10 @@ module Seam
|
|
|
1927
1948
|
resource_accessor :current_climate_setting, CurrentClimateSetting
|
|
1928
1949
|
# @return [DefaultClimateSetting, nil]
|
|
1929
1950
|
resource_accessor :default_climate_setting, DefaultClimateSetting
|
|
1930
|
-
# Current [temperature threshold](https://
|
|
1951
|
+
# Current [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.
|
|
1931
1952
|
# @return [TemperatureThreshold, nil]
|
|
1932
1953
|
resource_accessor :temperature_threshold, TemperatureThreshold
|
|
1933
|
-
# Current [weekly program](https://
|
|
1954
|
+
# Current [weekly program](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
1934
1955
|
# @return [ThermostatWeeklyProgram, nil]
|
|
1935
1956
|
resource_accessor :thermostat_weekly_program, ThermostatWeeklyProgram
|
|
1936
1957
|
# 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 +1963,10 @@ module Seam
|
|
|
1942
1963
|
# 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
1964
|
# @return [Array<OnlineTimeFrameOptions>]
|
|
1944
1965
|
resource_list_accessor :online_time_frame_options, OnlineTimeFrameOptions
|
|
1945
|
-
# Available [climate presets](https://
|
|
1966
|
+
# Available [climate presets](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.
|
|
1946
1967
|
# @return [Array<AvailableClimatePresets>]
|
|
1947
1968
|
resource_list_accessor :available_climate_presets, AvailableClimatePresets
|
|
1948
|
-
# Configured [daily programs](https://
|
|
1969
|
+
# Configured [daily programs](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.
|
|
1949
1970
|
# @return [Array<ThermostatDailyPrograms>]
|
|
1950
1971
|
resource_list_accessor :thermostat_daily_programs, ThermostatDailyPrograms
|
|
1951
1972
|
# Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
|
|
@@ -1999,7 +2020,7 @@ module Seam
|
|
|
1999
2020
|
# Indicates whether automatic locking is enabled.
|
|
2000
2021
|
# @return [Boolean, nil]
|
|
2001
2022
|
attr_accessor :auto_lock_enabled
|
|
2002
|
-
# Indicates whether the [backup access code pool](https://
|
|
2023
|
+
# 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
2024
|
# @return [Boolean, nil]
|
|
2004
2025
|
attr_accessor :backup_access_code_pool_enabled
|
|
2005
2026
|
# Indicates whether the door is open.
|
|
@@ -2017,10 +2038,10 @@ module Seam
|
|
|
2017
2038
|
# Supported code lengths for access codes.
|
|
2018
2039
|
# @return [Array<Float>]
|
|
2019
2040
|
attr_accessor :supported_code_lengths
|
|
2020
|
-
# Indicates whether the device supports a [backup access code pool](https://
|
|
2041
|
+
# 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
2042
|
# @return [Boolean, nil]
|
|
2022
2043
|
attr_accessor :supports_backup_access_code_pool
|
|
2023
|
-
# ID of the active [thermostat schedule](https://
|
|
2044
|
+
# ID of the active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
2024
2045
|
# @return [String, nil]
|
|
2025
2046
|
attr_accessor :active_thermostat_schedule_id
|
|
2026
2047
|
# Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".
|
|
@@ -2049,7 +2070,7 @@ module Seam
|
|
|
2049
2070
|
# - `heat_cool`
|
|
2050
2071
|
# - `eco`
|
|
2051
2072
|
attr_accessor :available_hvac_mode_settings
|
|
2052
|
-
# Key of the [fallback climate preset](https://
|
|
2073
|
+
# 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
2074
|
# @return [String, nil]
|
|
2054
2075
|
attr_accessor :fallback_climate_preset_key
|
|
2055
2076
|
# @return [String, nil]
|
|
@@ -2071,16 +2092,16 @@ module Seam
|
|
|
2071
2092
|
# 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
2093
|
# @return [Boolean, nil]
|
|
2073
2094
|
attr_accessor :is_temporary_manual_override_active
|
|
2074
|
-
# Maximum [cooling set point](https://
|
|
2095
|
+
# Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2075
2096
|
# @return [Float, nil]
|
|
2076
2097
|
attr_accessor :max_cooling_set_point_celsius
|
|
2077
|
-
# Maximum [cooling set point](https://
|
|
2098
|
+
# Maximum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2078
2099
|
# @return [Float, nil]
|
|
2079
2100
|
attr_accessor :max_cooling_set_point_fahrenheit
|
|
2080
|
-
# Maximum [heating set point](https://
|
|
2101
|
+
# Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2081
2102
|
# @return [Float, nil]
|
|
2082
2103
|
attr_accessor :max_heating_set_point_celsius
|
|
2083
|
-
# Maximum [heating set point](https://
|
|
2104
|
+
# Maximum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2084
2105
|
# @return [Float, nil]
|
|
2085
2106
|
attr_accessor :max_heating_set_point_fahrenheit
|
|
2086
2107
|
# 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 +2110,22 @@ module Seam
|
|
|
2089
2110
|
# Maximum number of climate presets that the thermostat can support for weekly programming.
|
|
2090
2111
|
# @return [Float, nil]
|
|
2091
2112
|
attr_accessor :max_unique_climate_presets_per_thermostat_weekly_program
|
|
2092
|
-
# Minimum [cooling set point](https://
|
|
2113
|
+
# Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.
|
|
2093
2114
|
# @return [Float, nil]
|
|
2094
2115
|
attr_accessor :min_cooling_set_point_celsius
|
|
2095
|
-
# Minimum [cooling set point](https://
|
|
2116
|
+
# Minimum [cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.
|
|
2096
2117
|
# @return [Float, nil]
|
|
2097
2118
|
attr_accessor :min_cooling_set_point_fahrenheit
|
|
2098
|
-
# Minimum [temperature difference](https://
|
|
2119
|
+
# 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
2120
|
# @return [Float, nil]
|
|
2100
2121
|
attr_accessor :min_heating_cooling_delta_celsius
|
|
2101
|
-
# Minimum [temperature difference](https://
|
|
2122
|
+
# 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
2123
|
# @return [Float, nil]
|
|
2103
2124
|
attr_accessor :min_heating_cooling_delta_fahrenheit
|
|
2104
|
-
# Minimum [heating set point](https://
|
|
2125
|
+
# Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.
|
|
2105
2126
|
# @return [Float, nil]
|
|
2106
2127
|
attr_accessor :min_heating_set_point_celsius
|
|
2107
|
-
# Minimum [heating set point](https://
|
|
2128
|
+
# Minimum [heating set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.
|
|
2108
2129
|
# @return [Float, nil]
|
|
2109
2130
|
attr_accessor :min_heating_set_point_fahrenheit
|
|
2110
2131
|
# Reported relative humidity, as a value between 0 and 1, inclusive.
|
|
@@ -2698,7 +2719,7 @@ module Seam
|
|
|
2698
2719
|
# Indicates whether the lock supports unlocking with an access code.
|
|
2699
2720
|
# @return [Boolean, nil]
|
|
2700
2721
|
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://
|
|
2722
|
+
# 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
2723
|
# @return [Array<String>]
|
|
2703
2724
|
# Known values:
|
|
2704
2725
|
# - `access_code`
|
|
@@ -2711,7 +2732,7 @@ module Seam
|
|
|
2711
2732
|
# Unique identifier for the account associated with the device.
|
|
2712
2733
|
# @return [String]
|
|
2713
2734
|
attr_accessor :connected_account_id
|
|
2714
|
-
# Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://
|
|
2735
|
+
# 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
2736
|
# @return [Hash{String => String, Boolean}]
|
|
2716
2737
|
attr_accessor :custom_metadata
|
|
2717
2738
|
# ID of the device.
|
|
@@ -2764,11 +2785,12 @@ module Seam
|
|
|
2764
2785
|
# - `android_phone`
|
|
2765
2786
|
# - `ring_camera`
|
|
2766
2787
|
# - `tapo_camera`
|
|
2788
|
+
# - `arlo_camera`
|
|
2767
2789
|
attr_accessor :device_type
|
|
2768
2790
|
# 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
2791
|
# @return [String]
|
|
2770
2792
|
attr_accessor :display_name
|
|
2771
|
-
# Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://
|
|
2793
|
+
# 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
2794
|
# @return [TrueClass]
|
|
2773
2795
|
attr_accessor :is_managed
|
|
2774
2796
|
# Optional nickname to describe the device, settable through Seam.
|