Add additional endpoints for Home Theater to set Home Theater Options (night mode, speech enhancement)

It's also possible to get 'grouping latency' from the Sonos API, so it's included in the object here

Author: nightowlengineer

src/main/java/engineer/nightowl/sonos/api/domain/SonosHomeTheaterOptions.java

@@ -0,0 +1,88 @@
+package engineer.nightowl.sonos.api.domain;
+
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+
+public class SonosHomeTheaterOptions
+{
+    private Boolean nightMode;
+    private Boolean enhanceDialog;
+    private Integer groupingLatency;
+
+    public SonosHomeTheaterOptions()
+    {
+    }
+
+    public SonosHomeTheaterOptions(Boolean nightMode, Boolean enhanceDialog, Integer groupingLatency)
+    {
+        this.nightMode = nightMode;
+        this.enhanceDialog = enhanceDialog;
+        this.groupingLatency = groupingLatency;
+    }
+
+    public Boolean getNightMode()
+    {
+        return nightMode;
+    }
+
+    public void setNightMode(Boolean nightMode)
+    {
+        this.nightMode = nightMode;
+    }
+
+    public Boolean getEnhanceDialog()
+    {
+        return enhanceDialog;
+    }
+
+    public void setEnhanceDialog(Boolean enhanceDialog)
+    {
+        this.enhanceDialog = enhanceDialog;
+    }
+
+    public Integer getGroupingLatency()
+    {
+        return groupingLatency;
+    }
+
+    public void setGroupingLatency(Integer groupingLatency)
+    {
+        this.groupingLatency = groupingLatency;
+    }
+
+    @Override
+    public String toString()
+    {
+        return "SonosHomeTheaterOptions{" +
+                "nightMode=" + nightMode +
+                ", enhanceDialog=" + enhanceDialog +
+                ", groupingLatency=" + groupingLatency +
+                '}';
+    }
+
+    @Override
+    public boolean equals(Object o)
+    {
+        if (this == o) return true;
+
+        if (o == null || getClass() != o.getClass()) return false;
+
+        SonosHomeTheaterOptions that = (SonosHomeTheaterOptions) o;
+
+        return new EqualsBuilder()
+                .append(nightMode, that.nightMode)
+                .append(enhanceDialog, that.enhanceDialog)
+                .append(groupingLatency, that.groupingLatency)
+                .isEquals();
+    }
+
+    @Override
+    public int hashCode()
+    {
+        return new HashCodeBuilder(17, 37)
+                .append(nightMode)
+                .append(enhanceDialog)
+                .append(groupingLatency)
+                .toHashCode();
+    }
+}

src/main/java/engineer/nightowl/sonos/api/enums/SonosType.java

@@ -16,6 +16,7 @@ public enum SonosType
     globalError(SonosApiError.class),
     groups(SonosGroups.class),
     groupVolume(SonosGroupVolume.class),
+    homeTheaterOptions(SonosHomeTheaterOptions.class),
     households(SonosHouseholdList.class),
     MusicServiceAccount(SonosMusicServiceAccount.class),
     playbackError(SonosPlaybackError.class),

src/main/java/engineer/nightowl/sonos/api/resource/HomeTheaterResource.java

@@ -1,6 +1,7 @@
 package engineer.nightowl.sonos.api.resource;
 
 import engineer.nightowl.sonos.api.SonosApiClient;
+import engineer.nightowl.sonos.api.domain.SonosHomeTheaterOptions;
 import engineer.nightowl.sonos.api.domain.SonosSuccess;
 import engineer.nightowl.sonos.api.enums.SonosTvPowerState;
 import engineer.nightowl.sonos.api.exception.SonosApiClientException;
@@ -60,4 +61,35 @@ public SonosSuccess setTvPowerState(final String clientToken, final String playe
 
         return postToApi(SonosSuccess.class, clientToken, String.format("/v1/players/%s/homeTheater/tvPowerState", playerId), payload);
     }
+
+    /**
+     * Get home theater options for a specified player
+     *
+     * @see <a href="https://developer.sonos.com/reference/control-api/hometheater/getoptions/">Sonos docs</a>
+     * @param clientToken for the user
+     * @param playerId to get the options for
+     * @return the home theater options for the specified player
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiClientException if an error occurs during the call
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiError           if the API returns an error
+     */
+    public SonosHomeTheaterOptions getOptions(final String clientToken, final String playerId) throws SonosApiClientException, SonosApiError
+    {
+        return getFromApi(SonosHomeTheaterOptions.class, clientToken, String.format("/v1/players/%s/homeTheater/options", playerId));
+    }
+
+    /**
+     * Set home theater options for a specifier player
+     *
+     * @see <a href="https://developer.sonos.com/reference/control-api/hometheater/setoptions/">Sonos docs</a>
+     * @param clientToken  for the user
+     * @param playerId     to set the options for
+     * @param homeTheaterOptions configured {@link engineer.nightowl.sonos.api.domain.SonosHomeTheaterOptions}
+     * @return the configured options if successful
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiClientException if an error occurs during the call
+     * @throws engineer.nightowl.sonos.api.exception.SonosApiError if there is an error from the API
+     */
+    public SonosHomeTheaterOptions setOptions(final String clientToken, final String playerId, final SonosHomeTheaterOptions homeTheaterOptions) throws SonosApiClientException, SonosApiError
+    {
+        return postToApi(SonosHomeTheaterOptions.class, clientToken, String.format("/v1/players/%s/homeTheater/options", playerId), homeTheaterOptions);
+    }
 }