ch.loway.oss.ari4java.generated.actions.ActionDeviceStates Maven / Gradle / Ivy

package ch.loway.oss.ari4java.generated.actions;

// ----------------------------------------------------
//      THIS CLASS WAS GENERATED AUTOMATICALLY
//               PLEASE DO NOT EDIT
//    Generated on: Sat Aug 14 16:51:30 SAST 2021
// ----------------------------------------------------

import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.ArrayList;
import ch.loway.oss.ari4java.tools.*;
import ch.loway.oss.ari4java.tools.tags.EventSource;
import ch.loway.oss.ari4java.generated.actions.requests.*;
import ch.loway.oss.ari4java.generated.models.Module;
import ch.loway.oss.ari4java.generated.models.*;

/** Generated by: JavaInterface */
public interface ActionDeviceStates {
  /**
   * Destroy a device-state controlled by ARI.
   *
   * @param deviceName Name of the device
   * @return DeviceStatesDeleteRequest
   * @throws RestException an error
   * @since ARI_0_0_1
   */
  public DeviceStatesDeleteRequest delete(String deviceName) throws RestException;
  /**
   * List all ARI controlled device states.
   *
   * @return DeviceStatesListGetRequest
   * @throws RestException an error
   * @since ARI_0_0_1
   */
  public DeviceStatesListGetRequest list() throws RestException;
  /**
   * Retrieve the current state of a device.
   *
   * @param deviceName Name of the device
   * @return DeviceStatesGetRequest
   * @throws RestException an error
   * @since ARI_0_0_1
   */
  public DeviceStatesGetRequest get(String deviceName) throws RestException;
  /**
   * Change the state of a device controlled by ARI. (Note - implicitly creates the device state).
   *
   * @param deviceName Name of the device
   * @param deviceState Device state value
   * @return DeviceStatesUpdatePutRequest
   * @throws RestException an error
   * @since ARI_0_0_1
   */
  public DeviceStatesUpdatePutRequest update(String deviceName, String deviceState)
      throws RestException;
}