com.sinch.sdk.domains.voice.models.dto.v1.SvamlInstructionSendDtmfDto Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation
SDK providing a Java API for the Sinch REST APIs.
There is a newer version: 1.4.0
/*
 * Voice API | Sinch
 * The Voice API exposes calling- and conference-related functionality in the Sinch Voice Platform.
 *
 * The version of the OpenAPI document: 1.0.1
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

package com.sinch.sdk.domains.voice.models.dto.v1;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonFilter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Objects;

/** Plays DTMF tones in the call. */
@JsonPropertyOrder({
  SvamlInstructionSendDtmfDto.JSON_PROPERTY_NAME,
  SvamlInstructionSendDtmfDto.JSON_PROPERTY_VALUE
})
@JsonFilter("uninitializedFilter")
@JsonInclude(value = JsonInclude.Include.CUSTOM)
public class SvamlInstructionSendDtmfDto {
  private static final long serialVersionUID = 1L;

  /** The `name` property. Must have the value `sendDtmf`. */
  public enum NameEnum {
    SENDDTMF("sendDtmf"),

    UNKNOWN_DEFAULT_OPEN_API("unknown_default_open_api");

    private String value;

    NameEnum(String value) {
      this.value = value;
    }

    @JsonValue
    public String getValue() {
      return value;
    }

    @Override
    public String toString() {
      return String.valueOf(value);
    }

    @JsonCreator
    public static NameEnum fromValue(String value) {
      for (NameEnum b : NameEnum.values()) {
        if (b.value.equals(value)) {
          return b;
        }
      }
      return UNKNOWN_DEFAULT_OPEN_API;
    }
  }

  public static final String JSON_PROPERTY_NAME = "name";
  private String name;
  private boolean nameDefined = false;

  public static final String JSON_PROPERTY_VALUE = "value";
  private String value;
  private boolean valueDefined = false;

  public SvamlInstructionSendDtmfDto() {}

  public SvamlInstructionSendDtmfDto name(String name) {
    this.name = name;
    this.nameDefined = true;
    return this;
  }

  /**
   * The `name` property. Must have the value `sendDtmf`.
   *
   * @return name
   */
  @JsonProperty(JSON_PROPERTY_NAME)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public String getName() {
    return name;
  }

  @JsonIgnore
  public boolean getNameDefined() {
    return nameDefined;
  }

  @JsonProperty(JSON_PROPERTY_NAME)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setName(String name) {
    this.name = name;
    this.nameDefined = true;
  }

  public SvamlInstructionSendDtmfDto value(String value) {
    this.value = value;
    this.valueDefined = true;
    return this;
  }

  /**
   * A string that determines the DTMF tones to play to the callee when the call is picked up. Valid
   * characters are: `0-9`, `#`, and `w`. `w` renders a
   * 500ms pause. For example, the string `ww1234#w#`, plays a 1 second pause, the DTMF
   * tones for `1`, `2`, `3`, `4`, and `#`,
   * followed by a 500ms pause and finally the `#` tone. This is useful if the callout
   * destination requires a conference PIN code or an extension. If there is a calling party, it
   * will hear progress while the DTMF is sent.
   *
   * @return value
   */
  @JsonProperty(JSON_PROPERTY_VALUE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public String getValue() {
    return value;
  }

  @JsonIgnore
  public boolean getValueDefined() {
    return valueDefined;
  }

  @JsonProperty(JSON_PROPERTY_VALUE)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setValue(String value) {
    this.value = value;
    this.valueDefined = true;
  }

  /** Return true if this svaml.instruction.sendDtmf object is equal to o. */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    SvamlInstructionSendDtmfDto svamlInstructionSendDtmf = (SvamlInstructionSendDtmfDto) o;
    return Objects.equals(this.name, svamlInstructionSendDtmf.name)
        && Objects.equals(this.value, svamlInstructionSendDtmf.value);
  }

  @Override
  public int hashCode() {
    return Objects.hash(name, value);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SvamlInstructionSendDtmfDto {\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    value: ").append(toIndentedString(value)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces (except the first line).
   */
  private String toIndentedString(Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }
}