com.mypurecloud.sdk.model.Callback Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of platform-client Show documentation
Show all versions of platform-client Show documentation
The official Java SDK for the PureCloud Platform API SDK
The newest version!
package com.mypurecloud.sdk.model;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import com.mypurecloud.sdk.model.DialerPreview;
import com.mypurecloud.sdk.model.Segment;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.io.Serializable;
/**
* Callback
*/
public class Callback implements Serializable {
/**
* The connection state of this communication.
*/
public enum StateEnum {
OUTDATEDSDKVERSION("OutdatedSdkVersion"),
ALERTING("alerting"),
DIALING("dialing"),
CONTACTING("contacting"),
OFFERING("offering"),
CONNECTED("connected"),
DISCONNECTED("disconnected"),
TERMINATED("terminated"),
SCHEDULED("scheduled"),
NONE("none");
private String value;
StateEnum(String value) {
this.value = value;
}
@JsonCreator
public static StateEnum fromString(String key) {
if (key == null) return null;
for (StateEnum value : StateEnum.values()) {
if (key.equalsIgnoreCase(value.toString())) {
return value;
}
}
return StateEnum.values()[0];
}
@Override
@JsonValue
public String toString() {
return String.valueOf(value);
}
}
private StateEnum state = null;
private String id = null;
private List segments = new ArrayList();
/**
* The direction of the call
*/
public enum DirectionEnum {
OUTDATEDSDKVERSION("OutdatedSdkVersion"),
INBOUND("inbound"),
OUTBOUND("outbound");
private String value;
DirectionEnum(String value) {
this.value = value;
}
@JsonCreator
public static DirectionEnum fromString(String key) {
if (key == null) return null;
for (DirectionEnum value : DirectionEnum.values()) {
if (key.equalsIgnoreCase(value.toString())) {
return value;
}
}
return DirectionEnum.values()[0];
}
@Override
@JsonValue
public String toString() {
return String.valueOf(value);
}
}
private DirectionEnum direction = null;
private Boolean held = null;
/**
* System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
*/
public enum DisconnectTypeEnum {
OUTDATEDSDKVERSION("OutdatedSdkVersion"),
ENDPOINT("endpoint"),
CLIENT("client"),
SYSTEM("system"),
TIMEOUT("timeout"),
TRANSFER("transfer"),
TRANSFER_CONFERENCE("transfer.conference"),
TRANSFER_CONSULT("transfer.consult"),
TRANSFER_FORWARD("transfer.forward"),
TRANSFER_NOANSWER("transfer.noanswer"),
TRANSFER_NOTAVAILABLE("transfer.notavailable"),
TRANSPORT_FAILURE("transport.failure"),
ERROR("error"),
PEER("peer"),
OTHER("other"),
SPAM("spam"),
UNCALLABLE("uncallable");
private String value;
DisconnectTypeEnum(String value) {
this.value = value;
}
@JsonCreator
public static DisconnectTypeEnum fromString(String key) {
if (key == null) return null;
for (DisconnectTypeEnum value : DisconnectTypeEnum.values()) {
if (key.equalsIgnoreCase(value.toString())) {
return value;
}
}
return DisconnectTypeEnum.values()[0];
}
@Override
@JsonValue
public String toString() {
return String.valueOf(value);
}
}
private DisconnectTypeEnum disconnectType = null;
private Date startHoldTime = null;
private DialerPreview dialerPreview = null;
private List callbackNumbers = new ArrayList();
private String callbackUserName = null;
private String scriptId = null;
private Boolean skipEnabled = null;
private Integer timeoutSeconds = null;
private Date connectedTime = null;
private Date disconnectedTime = null;
private Date callbackScheduledTime = null;
private String automatedCallbackConfigId = null;
private String provider = null;
/**
* The connection state of this communication.
**/
public Callback state(StateEnum state) {
this.state = state;
return this;
}
@ApiModelProperty(example = "null", value = "The connection state of this communication.")
@JsonProperty("state")
public StateEnum getState() {
return state;
}
public void setState(StateEnum state) {
this.state = state;
}
/**
* A globally unique identifier for this communication.
**/
public Callback id(String id) {
this.id = id;
return this;
}
@ApiModelProperty(example = "null", value = "A globally unique identifier for this communication.")
@JsonProperty("id")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
/**
* The time line of the participant's callback, divided into activity segments.
**/
public Callback segments(List segments) {
this.segments = segments;
return this;
}
@ApiModelProperty(example = "null", value = "The time line of the participant's callback, divided into activity segments.")
@JsonProperty("segments")
public List getSegments() {
return segments;
}
public void setSegments(List segments) {
this.segments = segments;
}
/**
* The direction of the call
**/
public Callback direction(DirectionEnum direction) {
this.direction = direction;
return this;
}
@ApiModelProperty(example = "null", value = "The direction of the call")
@JsonProperty("direction")
public DirectionEnum getDirection() {
return direction;
}
public void setDirection(DirectionEnum direction) {
this.direction = direction;
}
/**
* True if this call is held and the person on this side hears silence.
**/
public Callback held(Boolean held) {
this.held = held;
return this;
}
@ApiModelProperty(example = "null", value = "True if this call is held and the person on this side hears silence.")
@JsonProperty("held")
public Boolean getHeld() {
return held;
}
public void setHeld(Boolean held) {
this.held = held;
}
/**
* System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.
**/
public Callback disconnectType(DisconnectTypeEnum disconnectType) {
this.disconnectType = disconnectType;
return this;
}
@ApiModelProperty(example = "null", value = "System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.")
@JsonProperty("disconnectType")
public DisconnectTypeEnum getDisconnectType() {
return disconnectType;
}
public void setDisconnectType(DisconnectTypeEnum disconnectType) {
this.disconnectType = disconnectType;
}
/**
* The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Callback startHoldTime(Date startHoldTime) {
this.startHoldTime = startHoldTime;
return this;
}
@ApiModelProperty(example = "null", value = "The timestamp the callback was placed on hold in the cloud clock if the callback is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ")
@JsonProperty("startHoldTime")
public Date getStartHoldTime() {
return startHoldTime;
}
public void setStartHoldTime(Date startHoldTime) {
this.startHoldTime = startHoldTime;
}
/**
* The preview data to be used when this callback is a Preview.
**/
public Callback dialerPreview(DialerPreview dialerPreview) {
this.dialerPreview = dialerPreview;
return this;
}
@ApiModelProperty(example = "null", value = "The preview data to be used when this callback is a Preview.")
@JsonProperty("dialerPreview")
public DialerPreview getDialerPreview() {
return dialerPreview;
}
public void setDialerPreview(DialerPreview dialerPreview) {
this.dialerPreview = dialerPreview;
}
/**
* The phone number(s) to use to place the callback.
**/
public Callback callbackNumbers(List callbackNumbers) {
this.callbackNumbers = callbackNumbers;
return this;
}
@ApiModelProperty(example = "null", value = "The phone number(s) to use to place the callback.")
@JsonProperty("callbackNumbers")
public List getCallbackNumbers() {
return callbackNumbers;
}
public void setCallbackNumbers(List callbackNumbers) {
this.callbackNumbers = callbackNumbers;
}
/**
* The name of the user requesting a callback.
**/
public Callback callbackUserName(String callbackUserName) {
this.callbackUserName = callbackUserName;
return this;
}
@ApiModelProperty(example = "null", value = "The name of the user requesting a callback.")
@JsonProperty("callbackUserName")
public String getCallbackUserName() {
return callbackUserName;
}
public void setCallbackUserName(String callbackUserName) {
this.callbackUserName = callbackUserName;
}
/**
* The UUID of the script to use.
**/
public Callback scriptId(String scriptId) {
this.scriptId = scriptId;
return this;
}
@ApiModelProperty(example = "null", value = "The UUID of the script to use.")
@JsonProperty("scriptId")
public String getScriptId() {
return scriptId;
}
public void setScriptId(String scriptId) {
this.scriptId = scriptId;
}
/**
* True if the ability to skip a callback should be enabled.
**/
public Callback skipEnabled(Boolean skipEnabled) {
this.skipEnabled = skipEnabled;
return this;
}
@ApiModelProperty(example = "null", value = "True if the ability to skip a callback should be enabled.")
@JsonProperty("skipEnabled")
public Boolean getSkipEnabled() {
return skipEnabled;
}
public void setSkipEnabled(Boolean skipEnabled) {
this.skipEnabled = skipEnabled;
}
/**
* The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled.
**/
public Callback timeoutSeconds(Integer timeoutSeconds) {
this.timeoutSeconds = timeoutSeconds;
return this;
}
@ApiModelProperty(example = "null", value = "The number of seconds before the system automatically places a call for a callback. 0 means the automatic placement is disabled.")
@JsonProperty("timeoutSeconds")
public Integer getTimeoutSeconds() {
return timeoutSeconds;
}
public void setTimeoutSeconds(Integer timeoutSeconds) {
this.timeoutSeconds = timeoutSeconds;
}
/**
* The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Callback connectedTime(Date connectedTime) {
this.connectedTime = connectedTime;
return this;
}
@ApiModelProperty(example = "null", value = "The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ")
@JsonProperty("connectedTime")
public Date getConnectedTime() {
return connectedTime;
}
public void setConnectedTime(Date connectedTime) {
this.connectedTime = connectedTime;
}
/**
* The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Callback disconnectedTime(Date disconnectedTime) {
this.disconnectedTime = disconnectedTime;
return this;
}
@ApiModelProperty(example = "null", value = "The timestamp when this communication disconnected from the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ")
@JsonProperty("disconnectedTime")
public Date getDisconnectedTime() {
return disconnectedTime;
}
public void setDisconnectedTime(Date disconnectedTime) {
this.disconnectedTime = disconnectedTime;
}
/**
* The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Callback callbackScheduledTime(Date callbackScheduledTime) {
this.callbackScheduledTime = callbackScheduledTime;
return this;
}
@ApiModelProperty(example = "null", value = "The timestamp when this communication is scheduled in the provider clock. If this value is missing it indicates the callback will be placed immediately. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ")
@JsonProperty("callbackScheduledTime")
public Date getCallbackScheduledTime() {
return callbackScheduledTime;
}
public void setCallbackScheduledTime(Date callbackScheduledTime) {
this.callbackScheduledTime = callbackScheduledTime;
}
/**
* The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal.
**/
public Callback automatedCallbackConfigId(String automatedCallbackConfigId) {
this.automatedCallbackConfigId = automatedCallbackConfigId;
return this;
}
@ApiModelProperty(example = "null", value = "The id of the config for automatically placing the callback (and handling the disposition). If null, the callback will not be placed automatically but routed to an agent as per normal.")
@JsonProperty("automatedCallbackConfigId")
public String getAutomatedCallbackConfigId() {
return automatedCallbackConfigId;
}
public void setAutomatedCallbackConfigId(String automatedCallbackConfigId) {
this.automatedCallbackConfigId = automatedCallbackConfigId;
}
/**
* The source provider for the callback.
**/
public Callback provider(String provider) {
this.provider = provider;
return this;
}
@ApiModelProperty(example = "null", value = "The source provider for the callback.")
@JsonProperty("provider")
public String getProvider() {
return provider;
}
public void setProvider(String provider) {
this.provider = provider;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Callback callback = (Callback) o;
return Objects.equals(this.state, callback.state) &&
Objects.equals(this.id, callback.id) &&
Objects.equals(this.segments, callback.segments) &&
Objects.equals(this.direction, callback.direction) &&
Objects.equals(this.held, callback.held) &&
Objects.equals(this.disconnectType, callback.disconnectType) &&
Objects.equals(this.startHoldTime, callback.startHoldTime) &&
Objects.equals(this.dialerPreview, callback.dialerPreview) &&
Objects.equals(this.callbackNumbers, callback.callbackNumbers) &&
Objects.equals(this.callbackUserName, callback.callbackUserName) &&
Objects.equals(this.scriptId, callback.scriptId) &&
Objects.equals(this.skipEnabled, callback.skipEnabled) &&
Objects.equals(this.timeoutSeconds, callback.timeoutSeconds) &&
Objects.equals(this.connectedTime, callback.connectedTime) &&
Objects.equals(this.disconnectedTime, callback.disconnectedTime) &&
Objects.equals(this.callbackScheduledTime, callback.callbackScheduledTime) &&
Objects.equals(this.automatedCallbackConfigId, callback.automatedCallbackConfigId) &&
Objects.equals(this.provider, callback.provider);
}
@Override
public int hashCode() {
return Objects.hash(state, id, segments, direction, held, disconnectType, startHoldTime, dialerPreview, callbackNumbers, callbackUserName, scriptId, skipEnabled, timeoutSeconds, connectedTime, disconnectedTime, callbackScheduledTime, automatedCallbackConfigId, provider);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Callback {\n");
sb.append(" state: ").append(toIndentedString(state)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" segments: ").append(toIndentedString(segments)).append("\n");
sb.append(" direction: ").append(toIndentedString(direction)).append("\n");
sb.append(" held: ").append(toIndentedString(held)).append("\n");
sb.append(" disconnectType: ").append(toIndentedString(disconnectType)).append("\n");
sb.append(" startHoldTime: ").append(toIndentedString(startHoldTime)).append("\n");
sb.append(" dialerPreview: ").append(toIndentedString(dialerPreview)).append("\n");
sb.append(" callbackNumbers: ").append(toIndentedString(callbackNumbers)).append("\n");
sb.append(" callbackUserName: ").append(toIndentedString(callbackUserName)).append("\n");
sb.append(" scriptId: ").append(toIndentedString(scriptId)).append("\n");
sb.append(" skipEnabled: ").append(toIndentedString(skipEnabled)).append("\n");
sb.append(" timeoutSeconds: ").append(toIndentedString(timeoutSeconds)).append("\n");
sb.append(" connectedTime: ").append(toIndentedString(connectedTime)).append("\n");
sb.append(" disconnectedTime: ").append(toIndentedString(disconnectedTime)).append("\n");
sb.append(" callbackScheduledTime: ").append(toIndentedString(callbackScheduledTime)).append("\n");
sb.append(" automatedCallbackConfigId: ").append(toIndentedString(automatedCallbackConfigId)).append("\n");
sb.append(" provider: ").append(toIndentedString(provider)).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(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}