seam 2.163.0 → 2.165.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.
@@ -1158,6 +1158,30 @@ module Seam
1158
1158
  attr_accessor :model
1159
1159
  end
1160
1160
 
1161
+ class SonosMetadata < BaseResource
1162
+ # Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.
1163
+ # @return [Array<String>]
1164
+ attr_accessor :bonded_member_models
1165
+ # Color of the speaker, as reported by Sonos.
1166
+ # @return [String, nil]
1167
+ attr_accessor :color
1168
+ # ID of the Sonos household that the speaker belongs to.
1169
+ # @return [String, nil]
1170
+ attr_accessor :household_id
1171
+ # Model name of the speaker, as reported by Sonos.
1172
+ # @return [String, nil]
1173
+ attr_accessor :model_display_name
1174
+ # ID of the Sonos player for the speaker.
1175
+ # @return [String, nil]
1176
+ attr_accessor :player_id
1177
+ # Name of the speaker, as set in the Sonos app.
1178
+ # @return [String, nil]
1179
+ attr_accessor :player_name
1180
+ # Software version running on the speaker.
1181
+ # @return [String, nil]
1182
+ attr_accessor :software_version
1183
+ end
1184
+
1161
1185
  class TadoMetadata < BaseResource
1162
1186
  # Device type for a tado° device.
1163
1187
  # @return [String, nil]
@@ -1442,6 +1466,60 @@ module Seam
1442
1466
  attr_accessor :time_zone
1443
1467
  end
1444
1468
 
1469
+ class Speaker < BaseResource
1470
+ class NowPlaying < BaseResource
1471
+ # Album of the content that is currently playing.
1472
+ # @return [String, nil]
1473
+ attr_accessor :album
1474
+ # Artist of the content that is currently playing.
1475
+ # @return [String, nil]
1476
+ attr_accessor :artist
1477
+ # Title of the content that is currently playing.
1478
+ # @return [String, nil]
1479
+ attr_accessor :title
1480
+ end
1481
+
1482
+ # Content that is currently playing on the speaker.
1483
+ # @return [NowPlaying, nil]
1484
+ resource_accessor :now_playing, NowPlaying
1485
+ # IDs of the other speakers that are currently grouped with this speaker. Pausing or resuming playback on a speaker also affects the speakers in its group.
1486
+ # @return [Array<String>]
1487
+ attr_accessor :grouped_with_device_ids
1488
+ # Indicates whether the speaker's volume is fixed, for example, because the speaker's line-out level is controlled by an external amplifier. A speaker with a fixed volume cannot have its volume set through Seam.
1489
+ # @return [Boolean]
1490
+ attr_accessor :has_fixed_volume
1491
+ # Indicates whether the speaker is muted.
1492
+ # @return [Boolean]
1493
+ attr_accessor :is_muted
1494
+ # Maximum volume that you can set on the speaker. This is the ceiling of the speaker's native volume scale, not a limit configured for guests.
1495
+ # @return [Float]
1496
+ attr_accessor :max_volume
1497
+ # Minimum volume that you can set on the speaker.
1498
+ # @return [Float]
1499
+ attr_accessor :min_volume
1500
+ # Playback state of the speaker.
1501
+ # @return [String]
1502
+ # Known values:
1503
+ # - `playing`
1504
+ # - `paused`
1505
+ # - `idle`
1506
+ # - `buffering`
1507
+ # - `unknown`
1508
+ attr_accessor :playback_state
1509
+ # Indicates whether the speaker can play a chime.
1510
+ # @return [Boolean]
1511
+ attr_accessor :supports_chime
1512
+ # Current volume of the speaker, on the speaker's native volume scale from `min_volume` to `max_volume`. This is the native volume setting, not a decibel level.
1513
+ # @return [Float]
1514
+ attr_accessor :volume
1515
+ # Increment between the volume values that you can set on the speaker.
1516
+ # @return [Float]
1517
+ attr_accessor :volume_step
1518
+ # Date and time at which the speaker first reported its current volume.
1519
+ # @return [Time, nil]
1520
+ date_accessor :volume_reported_at
1521
+ end
1522
+
1445
1523
  class ActiveThermostatSchedule < BaseResource
1446
1524
  class Errors < BaseResource
1447
1525
  # Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
@@ -1925,6 +2003,9 @@ module Seam
1925
2003
  # Metadata for a SmartThings device.
1926
2004
  # @return [SmartthingsMetadata, nil]
1927
2005
  resource_accessor :smartthings_metadata, SmartthingsMetadata
2006
+ # Metadata for a Sonos speaker.
2007
+ # @return [SonosMetadata, nil]
2008
+ resource_accessor :sonos_metadata, SonosMetadata
1928
2009
  # Metadata for a tado° device.
1929
2010
  # @return [TadoMetadata, nil]
1930
2011
  resource_accessor :tado_metadata, TadoMetadata
@@ -1955,6 +2036,9 @@ module Seam
1955
2036
  # Keypad battery status.
1956
2037
  # @return [KeypadBattery, nil]
1957
2038
  resource_accessor :keypad_battery, KeypadBattery
2039
+ # Audio state and capabilities of the speaker.
2040
+ # @return [Speaker, nil]
2041
+ resource_accessor :speaker, Speaker
1958
2042
  # Active [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
1959
2043
  # @return [ActiveThermostatSchedule, nil]
1960
2044
  resource_accessor :active_thermostat_schedule, ActiveThermostatSchedule
@@ -2689,6 +2773,15 @@ module Seam
2689
2773
  # Indicates whether the thermostat supports simultaneous heating and cooling.
2690
2774
  # @return [Boolean, nil]
2691
2775
  attr_accessor :can_hvac_heat_cool
2776
+ # Indicates whether the speaker supports muting and unmuting.
2777
+ # @return [Boolean, nil]
2778
+ attr_accessor :can_mute_speaker
2779
+ # Indicates whether the speaker supports pausing and resuming playback.
2780
+ # @return [Boolean, nil]
2781
+ attr_accessor :can_pause_speaker_playback
2782
+ # Indicates whether the speaker supports playing a chime.
2783
+ # @return [Boolean, nil]
2784
+ attr_accessor :can_play_speaker_chime
2692
2785
  # Indicates whether the device supports programming offline access codes.
2693
2786
  # @return [Boolean, nil]
2694
2787
  attr_accessor :can_program_offline_access_codes
@@ -2713,6 +2806,9 @@ module Seam
2713
2806
  # Indicates whether the thermostat supports running climate programs.
2714
2807
  # @return [Boolean, nil]
2715
2808
  attr_accessor :can_run_thermostat_programs
2809
+ # Indicates whether the speaker supports setting its volume.
2810
+ # @return [Boolean, nil]
2811
+ attr_accessor :can_set_speaker_volume
2716
2812
  # Indicates whether the device supports simulating connection in a sandbox.
2717
2813
  # @return [Boolean, nil]
2718
2814
  attr_accessor :can_simulate_connection
@@ -2808,6 +2904,7 @@ module Seam
2808
2904
  # - `tapo_camera`
2809
2905
  # - `arlo_camera`
2810
2906
  # - `reolink_camera`
2907
+ # - `sonos_speaker`
2811
2908
  attr_accessor :device_type
2812
2909
  # 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.
2813
2910
  # @return [String]
@@ -18,6 +18,15 @@ module Seam
18
18
  # Indicates whether the thermostat supports simultaneous heating and cooling.
19
19
  # @return [Boolean, nil]
20
20
  attr_accessor :can_hvac_heat_cool
21
+ # Indicates whether the speaker supports muting and unmuting.
22
+ # @return [Boolean, nil]
23
+ attr_accessor :can_mute_speaker
24
+ # Indicates whether the speaker supports pausing and resuming playback.
25
+ # @return [Boolean, nil]
26
+ attr_accessor :can_pause_speaker_playback
27
+ # Indicates whether the speaker supports playing a chime.
28
+ # @return [Boolean, nil]
29
+ attr_accessor :can_play_speaker_chime
21
30
  # Indicates whether the device supports programming offline access codes.
22
31
  # @return [Boolean, nil]
23
32
  attr_accessor :can_program_offline_access_codes
@@ -42,6 +51,9 @@ module Seam
42
51
  # Indicates whether the thermostat supports running climate programs.
43
52
  # @return [Boolean, nil]
44
53
  attr_accessor :can_run_thermostat_programs
54
+ # Indicates whether the speaker supports setting its volume.
55
+ # @return [Boolean, nil]
56
+ attr_accessor :can_set_speaker_volume
45
57
  # Indicates whether the device supports simulating connection in a sandbox.
46
58
  # @return [Boolean, nil]
47
59
  attr_accessor :can_simulate_connection
@@ -140,6 +152,7 @@ module Seam
140
152
  # - `omnitec`
141
153
  # - `kisi`
142
154
  # - `aqara`
155
+ # - `sonos`
143
156
  attr_accessor :device_provider_name
144
157
  # Display name for the device provider.
145
158
  # @return [String]