com.sinch.sdk.domains.voice.models.dto.v1.SvamlInstructionPlayFilesDto 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.ArrayList;
import java.util.List;
import java.util.Objects;

/**
 * Plays Interactive Voice Response (IVR) files for the supported locale or SSML commands at the
 * Sinch backend. An IVR message is played only on the caller's side.
 */
@JsonPropertyOrder({
  SvamlInstructionPlayFilesDto.JSON_PROPERTY_NAME,
  SvamlInstructionPlayFilesDto.JSON_PROPERTY_IDS,
  SvamlInstructionPlayFilesDto.JSON_PROPERTY_LOCALE
})
@JsonFilter("uninitializedFilter")
@JsonInclude(value = JsonInclude.Include.CUSTOM)
public class SvamlInstructionPlayFilesDto {
  private static final long serialVersionUID = 1L;

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

    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_IDS = "ids";
  private List ids;
  private boolean idsDefined = false;

  public static final String JSON_PROPERTY_LOCALE = "locale";
  private String locale;
  private boolean localeDefined = false;

  public SvamlInstructionPlayFilesDto() {}

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

  /**
   * The `name` property. Must have the value `playFiles`.
   *
   * @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 SvamlInstructionPlayFilesDto ids(List ids) {
    this.ids = ids;
    this.idsDefined = true;
    return this;
  }

  public SvamlInstructionPlayFilesDto addIdsItem(String idsItem) {
    if (this.ids == null) {
      this.ids = new ArrayList<>();
    }
    this.idsDefined = true;
    this.ids.add(idsItem);
    return this;
  }

  /**
   * The IDs of the files which will be played. These can be a URL to a file, SSML commands using
   * the `#ssml[]` element, or text using the `#tts[]` element.
   *
   * @return ids
   */
  @JsonProperty(JSON_PROPERTY_IDS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public List getIds() {
    return ids;
  }

  @JsonIgnore
  public boolean getIdsDefined() {
    return idsDefined;
  }

  @JsonProperty(JSON_PROPERTY_IDS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setIds(List ids) {
    this.ids = ids;
    this.idsDefined = true;
  }

  public SvamlInstructionPlayFilesDto locale(String locale) {
    this.locale = locale;
    this.localeDefined = true;
    return this;
  }

  /**
   * If using SSML or TTS, this is a required field. The voice and language you want to use for the
   * text-to-speech message. This can either be defined by the ISO 639 locale and language code or
   * by specifying a particular voice. Supported languages and voices are detailed
   * [here](../../voice-locales).
   *
   * @return locale
   */
  @JsonProperty(JSON_PROPERTY_LOCALE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public String getLocale() {
    return locale;
  }

  @JsonIgnore
  public boolean getLocaleDefined() {
    return localeDefined;
  }

  @JsonProperty(JSON_PROPERTY_LOCALE)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setLocale(String locale) {
    this.locale = locale;
    this.localeDefined = true;
  }

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

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

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class SvamlInstructionPlayFilesDto {\n");
    sb.append("    name: ").append(toIndentedString(name)).append("\n");
    sb.append("    ids: ").append(toIndentedString(ids)).append("\n");
    sb.append("    locale: ").append(toIndentedString(locale)).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    ");
  }
}