Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.mypurecloud.sdk.model.Participant Maven / Gradle / Ivy
The official Java SDK for the PureCloud Platform API SDK
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.Call;
import com.mypurecloud.sdk.model.Callback;
import com.mypurecloud.sdk.model.Cobrowsesession;
import com.mypurecloud.sdk.model.ConversationChat;
import com.mypurecloud.sdk.model.Email;
import com.mypurecloud.sdk.model.Evaluation;
import com.mypurecloud.sdk.model.Screenshare;
import com.mypurecloud.sdk.model.SocialExpression;
import com.mypurecloud.sdk.model.Video;
import com.mypurecloud.sdk.model.Wrapup;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.io.Serializable;
/**
* Participant
*/
public class Participant implements Serializable {
private String id = null;
private Date startTime = null;
private Date endTime = null;
private Date connectedTime = null;
private String name = null;
private String userUri = null;
private String userId = null;
private String externalContactId = null;
private String externalOrganizationId = null;
private String queueId = null;
private String groupId = null;
private String queueName = null;
private String purpose = null;
private String participantType = null;
private String consultParticipantId = null;
private String address = null;
private String ani = null;
private String aniName = null;
private String dnis = null;
private String locale = null;
private Boolean wrapupRequired = null;
/**
* This field controls how the UI prompts the agent for a wrapup.
*/
public enum WrapupPromptEnum {
OUTDATEDSDKVERSION("OutdatedSdkVersion"),
MANDATORY("mandatory"),
OPTIONAL("optional"),
TIMEOUT("timeout"),
FORCEDTIMEOUT("forcedTimeout");
private String value;
WrapupPromptEnum(String value) {
this.value = value;
}
@JsonCreator
public static WrapupPromptEnum fromString(String key) {
if (key == null) return null;
for (WrapupPromptEnum value : WrapupPromptEnum.values()) {
if (key.equalsIgnoreCase(value.toString())) {
return value;
}
}
return WrapupPromptEnum.values()[0];
}
@Override
@JsonValue
public String toString() {
return String.valueOf(value);
}
}
private WrapupPromptEnum wrapupPrompt = null;
private Integer wrapupTimeoutMs = null;
private Boolean wrapupSkipped = null;
private Wrapup wrapup = null;
private String monitoredParticipantId = null;
private Map attributes = new HashMap();
private List calls = new ArrayList();
private List callbacks = new ArrayList();
private List chats = new ArrayList();
private List cobrowsesessions = new ArrayList();
private List emails = new ArrayList();
private List screenshares = new ArrayList();
private List socialExpressions = new ArrayList();
private List videos = new ArrayList();
private List evaluations = new ArrayList();
/**
* A globally unique identifier for this conversation.
**/
public Participant id(String id) {
this.id = id;
return this;
}
@ApiModelProperty(example = "null", value = "A globally unique identifier for this conversation.")
@JsonProperty("id")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
/**
* The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Participant startTime(Date startTime) {
this.startTime = startTime;
return this;
}
@ApiModelProperty(example = "null", value = "The timestamp when this participant joined the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ")
@JsonProperty("startTime")
public Date getStartTime() {
return startTime;
}
public void setStartTime(Date startTime) {
this.startTime = startTime;
}
/**
* The timestamp when this participant 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 Participant endTime(Date endTime) {
this.endTime = endTime;
return this;
}
@ApiModelProperty(example = "null", value = "The timestamp when this participant 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("endTime")
public Date getEndTime() {
return endTime;
}
public void setEndTime(Date endTime) {
this.endTime = endTime;
}
/**
* The timestamp when this participant was connected to the conversation in the provider clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
**/
public Participant connectedTime(Date connectedTime) {
this.connectedTime = connectedTime;
return this;
}
@ApiModelProperty(example = "null", value = "The timestamp when this participant was connected to the conversation in the provider 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;
}
/**
* A human readable name identifying the participant.
**/
public Participant name(String name) {
this.name = name;
return this;
}
@ApiModelProperty(example = "null", value = "A human readable name identifying the participant.")
@JsonProperty("name")
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
/**
* If this participant represents a user, then this will be an URI that can be used to fetch the user.
**/
public Participant userUri(String userUri) {
this.userUri = userUri;
return this;
}
@ApiModelProperty(example = "null", value = "If this participant represents a user, then this will be an URI that can be used to fetch the user.")
@JsonProperty("userUri")
public String getUserUri() {
return userUri;
}
public void setUserUri(String userUri) {
this.userUri = userUri;
}
/**
* If this participant represents a user, then this will be the globally unique identifier for the user.
**/
public Participant userId(String userId) {
this.userId = userId;
return this;
}
@ApiModelProperty(example = "null", value = "If this participant represents a user, then this will be the globally unique identifier for the user.")
@JsonProperty("userId")
public String getUserId() {
return userId;
}
public void setUserId(String userId) {
this.userId = userId;
}
/**
* If this participant represents an external contact, then this will be the globally unique identifier for the external contact.
**/
public Participant externalContactId(String externalContactId) {
this.externalContactId = externalContactId;
return this;
}
@ApiModelProperty(example = "null", value = "If this participant represents an external contact, then this will be the globally unique identifier for the external contact.")
@JsonProperty("externalContactId")
public String getExternalContactId() {
return externalContactId;
}
public void setExternalContactId(String externalContactId) {
this.externalContactId = externalContactId;
}
/**
* If this participant represents an external org, then this will be the globally unique identifier for the external org.
**/
public Participant externalOrganizationId(String externalOrganizationId) {
this.externalOrganizationId = externalOrganizationId;
return this;
}
@ApiModelProperty(example = "null", value = "If this participant represents an external org, then this will be the globally unique identifier for the external org.")
@JsonProperty("externalOrganizationId")
public String getExternalOrganizationId() {
return externalOrganizationId;
}
public void setExternalOrganizationId(String externalOrganizationId) {
this.externalOrganizationId = externalOrganizationId;
}
/**
* If present, the queue id that the communication channel came in on.
**/
public Participant queueId(String queueId) {
this.queueId = queueId;
return this;
}
@ApiModelProperty(example = "null", value = "If present, the queue id that the communication channel came in on.")
@JsonProperty("queueId")
public String getQueueId() {
return queueId;
}
public void setQueueId(String queueId) {
this.queueId = queueId;
}
/**
* If present, group of users the participant represents.
**/
public Participant groupId(String groupId) {
this.groupId = groupId;
return this;
}
@ApiModelProperty(example = "null", value = "If present, group of users the participant represents.")
@JsonProperty("groupId")
public String getGroupId() {
return groupId;
}
public void setGroupId(String groupId) {
this.groupId = groupId;
}
/**
* If present, the queue name that the communication channel came in on.
**/
public Participant queueName(String queueName) {
this.queueName = queueName;
return this;
}
@ApiModelProperty(example = "null", value = "If present, the queue name that the communication channel came in on.")
@JsonProperty("queueName")
public String getQueueName() {
return queueName;
}
public void setQueueName(String queueName) {
this.queueName = queueName;
}
/**
* A well known string that specifies the purpose of this participant.
**/
public Participant purpose(String purpose) {
this.purpose = purpose;
return this;
}
@ApiModelProperty(example = "null", value = "A well known string that specifies the purpose of this participant.")
@JsonProperty("purpose")
public String getPurpose() {
return purpose;
}
public void setPurpose(String purpose) {
this.purpose = purpose;
}
/**
* A well known string that specifies the type of this participant.
**/
public Participant participantType(String participantType) {
this.participantType = participantType;
return this;
}
@ApiModelProperty(example = "null", value = "A well known string that specifies the type of this participant.")
@JsonProperty("participantType")
public String getParticipantType() {
return participantType;
}
public void setParticipantType(String participantType) {
this.participantType = participantType;
}
/**
* If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.
**/
public Participant consultParticipantId(String consultParticipantId) {
this.consultParticipantId = consultParticipantId;
return this;
}
@ApiModelProperty(example = "null", value = "If this participant is part of a consult transfer, then this will be the participant id of the participant being transferred.")
@JsonProperty("consultParticipantId")
public String getConsultParticipantId() {
return consultParticipantId;
}
public void setConsultParticipantId(String consultParticipantId) {
this.consultParticipantId = consultParticipantId;
}
/**
* The address for the this participant. For a phone call this will be the ANI.
**/
public Participant address(String address) {
this.address = address;
return this;
}
@ApiModelProperty(example = "null", value = "The address for the this participant. For a phone call this will be the ANI.")
@JsonProperty("address")
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
/**
* The address for the this participant. For a phone call this will be the ANI.
**/
public Participant ani(String ani) {
this.ani = ani;
return this;
}
@ApiModelProperty(example = "null", value = "The address for the this participant. For a phone call this will be the ANI.")
@JsonProperty("ani")
public String getAni() {
return ani;
}
public void setAni(String ani) {
this.ani = ani;
}
/**
* The ani-based name for this participant.
**/
public Participant aniName(String aniName) {
this.aniName = aniName;
return this;
}
@ApiModelProperty(example = "null", value = "The ani-based name for this participant.")
@JsonProperty("aniName")
public String getAniName() {
return aniName;
}
public void setAniName(String aniName) {
this.aniName = aniName;
}
/**
* The address for the this participant. For a phone call this will be the ANI.
**/
public Participant dnis(String dnis) {
this.dnis = dnis;
return this;
}
@ApiModelProperty(example = "null", value = "The address for the this participant. For a phone call this will be the ANI.")
@JsonProperty("dnis")
public String getDnis() {
return dnis;
}
public void setDnis(String dnis) {
this.dnis = dnis;
}
/**
* An ISO 639 language code specifying the locale for this participant
**/
public Participant locale(String locale) {
this.locale = locale;
return this;
}
@ApiModelProperty(example = "null", value = "An ISO 639 language code specifying the locale for this participant")
@JsonProperty("locale")
public String getLocale() {
return locale;
}
public void setLocale(String locale) {
this.locale = locale;
}
/**
* True iff this participant is required to enter wrapup for this conversation.
**/
public Participant wrapupRequired(Boolean wrapupRequired) {
this.wrapupRequired = wrapupRequired;
return this;
}
@ApiModelProperty(example = "null", value = "True iff this participant is required to enter wrapup for this conversation.")
@JsonProperty("wrapupRequired")
public Boolean getWrapupRequired() {
return wrapupRequired;
}
public void setWrapupRequired(Boolean wrapupRequired) {
this.wrapupRequired = wrapupRequired;
}
/**
* This field controls how the UI prompts the agent for a wrapup.
**/
public Participant wrapupPrompt(WrapupPromptEnum wrapupPrompt) {
this.wrapupPrompt = wrapupPrompt;
return this;
}
@ApiModelProperty(example = "null", value = "This field controls how the UI prompts the agent for a wrapup.")
@JsonProperty("wrapupPrompt")
public WrapupPromptEnum getWrapupPrompt() {
return wrapupPrompt;
}
public void setWrapupPrompt(WrapupPromptEnum wrapupPrompt) {
this.wrapupPrompt = wrapupPrompt;
}
/**
* Specifies how long a timed ACW session will last.
**/
public Participant wrapupTimeoutMs(Integer wrapupTimeoutMs) {
this.wrapupTimeoutMs = wrapupTimeoutMs;
return this;
}
@ApiModelProperty(example = "null", value = "Specifies how long a timed ACW session will last.")
@JsonProperty("wrapupTimeoutMs")
public Integer getWrapupTimeoutMs() {
return wrapupTimeoutMs;
}
public void setWrapupTimeoutMs(Integer wrapupTimeoutMs) {
this.wrapupTimeoutMs = wrapupTimeoutMs;
}
/**
* The UI sets this field when the agent chooses to skip entering a wrapup for this participant.
**/
public Participant wrapupSkipped(Boolean wrapupSkipped) {
this.wrapupSkipped = wrapupSkipped;
return this;
}
@ApiModelProperty(example = "null", value = "The UI sets this field when the agent chooses to skip entering a wrapup for this participant.")
@JsonProperty("wrapupSkipped")
public Boolean getWrapupSkipped() {
return wrapupSkipped;
}
public void setWrapupSkipped(Boolean wrapupSkipped) {
this.wrapupSkipped = wrapupSkipped;
}
/**
* Call wrap up or disposition data.
**/
public Participant wrapup(Wrapup wrapup) {
this.wrapup = wrapup;
return this;
}
@ApiModelProperty(example = "null", value = "Call wrap up or disposition data.")
@JsonProperty("wrapup")
public Wrapup getWrapup() {
return wrapup;
}
public void setWrapup(Wrapup wrapup) {
this.wrapup = wrapup;
}
/**
* If this participant is a monitor, then this will be the id of the participant that is being monitored.
**/
public Participant monitoredParticipantId(String monitoredParticipantId) {
this.monitoredParticipantId = monitoredParticipantId;
return this;
}
@ApiModelProperty(example = "null", value = "If this participant is a monitor, then this will be the id of the participant that is being monitored.")
@JsonProperty("monitoredParticipantId")
public String getMonitoredParticipantId() {
return monitoredParticipantId;
}
public void setMonitoredParticipantId(String monitoredParticipantId) {
this.monitoredParticipantId = monitoredParticipantId;
}
/**
* Additional participant attributes
**/
public Participant attributes(Map attributes) {
this.attributes = attributes;
return this;
}
@ApiModelProperty(example = "null", value = "Additional participant attributes")
@JsonProperty("attributes")
public Map getAttributes() {
return attributes;
}
public void setAttributes(Map attributes) {
this.attributes = attributes;
}
/**
**/
public Participant calls(List calls) {
this.calls = calls;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("calls")
public List getCalls() {
return calls;
}
public void setCalls(List calls) {
this.calls = calls;
}
/**
**/
public Participant callbacks(List callbacks) {
this.callbacks = callbacks;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("callbacks")
public List getCallbacks() {
return callbacks;
}
public void setCallbacks(List callbacks) {
this.callbacks = callbacks;
}
/**
**/
public Participant chats(List chats) {
this.chats = chats;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("chats")
public List getChats() {
return chats;
}
public void setChats(List chats) {
this.chats = chats;
}
/**
**/
public Participant cobrowsesessions(List cobrowsesessions) {
this.cobrowsesessions = cobrowsesessions;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("cobrowsesessions")
public List getCobrowsesessions() {
return cobrowsesessions;
}
public void setCobrowsesessions(List cobrowsesessions) {
this.cobrowsesessions = cobrowsesessions;
}
/**
**/
public Participant emails(List emails) {
this.emails = emails;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("emails")
public List getEmails() {
return emails;
}
public void setEmails(List emails) {
this.emails = emails;
}
/**
**/
public Participant screenshares(List screenshares) {
this.screenshares = screenshares;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("screenshares")
public List getScreenshares() {
return screenshares;
}
public void setScreenshares(List screenshares) {
this.screenshares = screenshares;
}
/**
**/
public Participant socialExpressions(List socialExpressions) {
this.socialExpressions = socialExpressions;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("socialExpressions")
public List getSocialExpressions() {
return socialExpressions;
}
public void setSocialExpressions(List socialExpressions) {
this.socialExpressions = socialExpressions;
}
/**
**/
public Participant videos(List videos) {
this.videos = videos;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("videos")
public List getVideos() {
return videos;
}
public void setVideos(List videos) {
this.videos = videos;
}
/**
**/
public Participant evaluations(List evaluations) {
this.evaluations = evaluations;
return this;
}
@ApiModelProperty(example = "null", value = "")
@JsonProperty("evaluations")
public List getEvaluations() {
return evaluations;
}
public void setEvaluations(List evaluations) {
this.evaluations = evaluations;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Participant participant = (Participant) o;
return Objects.equals(this.id, participant.id) &&
Objects.equals(this.startTime, participant.startTime) &&
Objects.equals(this.endTime, participant.endTime) &&
Objects.equals(this.connectedTime, participant.connectedTime) &&
Objects.equals(this.name, participant.name) &&
Objects.equals(this.userUri, participant.userUri) &&
Objects.equals(this.userId, participant.userId) &&
Objects.equals(this.externalContactId, participant.externalContactId) &&
Objects.equals(this.externalOrganizationId, participant.externalOrganizationId) &&
Objects.equals(this.queueId, participant.queueId) &&
Objects.equals(this.groupId, participant.groupId) &&
Objects.equals(this.queueName, participant.queueName) &&
Objects.equals(this.purpose, participant.purpose) &&
Objects.equals(this.participantType, participant.participantType) &&
Objects.equals(this.consultParticipantId, participant.consultParticipantId) &&
Objects.equals(this.address, participant.address) &&
Objects.equals(this.ani, participant.ani) &&
Objects.equals(this.aniName, participant.aniName) &&
Objects.equals(this.dnis, participant.dnis) &&
Objects.equals(this.locale, participant.locale) &&
Objects.equals(this.wrapupRequired, participant.wrapupRequired) &&
Objects.equals(this.wrapupPrompt, participant.wrapupPrompt) &&
Objects.equals(this.wrapupTimeoutMs, participant.wrapupTimeoutMs) &&
Objects.equals(this.wrapupSkipped, participant.wrapupSkipped) &&
Objects.equals(this.wrapup, participant.wrapup) &&
Objects.equals(this.monitoredParticipantId, participant.monitoredParticipantId) &&
Objects.equals(this.attributes, participant.attributes) &&
Objects.equals(this.calls, participant.calls) &&
Objects.equals(this.callbacks, participant.callbacks) &&
Objects.equals(this.chats, participant.chats) &&
Objects.equals(this.cobrowsesessions, participant.cobrowsesessions) &&
Objects.equals(this.emails, participant.emails) &&
Objects.equals(this.screenshares, participant.screenshares) &&
Objects.equals(this.socialExpressions, participant.socialExpressions) &&
Objects.equals(this.videos, participant.videos) &&
Objects.equals(this.evaluations, participant.evaluations);
}
@Override
public int hashCode() {
return Objects.hash(id, startTime, endTime, connectedTime, name, userUri, userId, externalContactId, externalOrganizationId, queueId, groupId, queueName, purpose, participantType, consultParticipantId, address, ani, aniName, dnis, locale, wrapupRequired, wrapupPrompt, wrapupTimeoutMs, wrapupSkipped, wrapup, monitoredParticipantId, attributes, calls, callbacks, chats, cobrowsesessions, emails, screenshares, socialExpressions, videos, evaluations);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Participant {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" startTime: ").append(toIndentedString(startTime)).append("\n");
sb.append(" endTime: ").append(toIndentedString(endTime)).append("\n");
sb.append(" connectedTime: ").append(toIndentedString(connectedTime)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" userUri: ").append(toIndentedString(userUri)).append("\n");
sb.append(" userId: ").append(toIndentedString(userId)).append("\n");
sb.append(" externalContactId: ").append(toIndentedString(externalContactId)).append("\n");
sb.append(" externalOrganizationId: ").append(toIndentedString(externalOrganizationId)).append("\n");
sb.append(" queueId: ").append(toIndentedString(queueId)).append("\n");
sb.append(" groupId: ").append(toIndentedString(groupId)).append("\n");
sb.append(" queueName: ").append(toIndentedString(queueName)).append("\n");
sb.append(" purpose: ").append(toIndentedString(purpose)).append("\n");
sb.append(" participantType: ").append(toIndentedString(participantType)).append("\n");
sb.append(" consultParticipantId: ").append(toIndentedString(consultParticipantId)).append("\n");
sb.append(" address: ").append(toIndentedString(address)).append("\n");
sb.append(" ani: ").append(toIndentedString(ani)).append("\n");
sb.append(" aniName: ").append(toIndentedString(aniName)).append("\n");
sb.append(" dnis: ").append(toIndentedString(dnis)).append("\n");
sb.append(" locale: ").append(toIndentedString(locale)).append("\n");
sb.append(" wrapupRequired: ").append(toIndentedString(wrapupRequired)).append("\n");
sb.append(" wrapupPrompt: ").append(toIndentedString(wrapupPrompt)).append("\n");
sb.append(" wrapupTimeoutMs: ").append(toIndentedString(wrapupTimeoutMs)).append("\n");
sb.append(" wrapupSkipped: ").append(toIndentedString(wrapupSkipped)).append("\n");
sb.append(" wrapup: ").append(toIndentedString(wrapup)).append("\n");
sb.append(" monitoredParticipantId: ").append(toIndentedString(monitoredParticipantId)).append("\n");
sb.append(" attributes: ").append(toIndentedString(attributes)).append("\n");
sb.append(" calls: ").append(toIndentedString(calls)).append("\n");
sb.append(" callbacks: ").append(toIndentedString(callbacks)).append("\n");
sb.append(" chats: ").append(toIndentedString(chats)).append("\n");
sb.append(" cobrowsesessions: ").append(toIndentedString(cobrowsesessions)).append("\n");
sb.append(" emails: ").append(toIndentedString(emails)).append("\n");
sb.append(" screenshares: ").append(toIndentedString(screenshares)).append("\n");
sb.append(" socialExpressions: ").append(toIndentedString(socialExpressions)).append("\n");
sb.append(" videos: ").append(toIndentedString(videos)).append("\n");
sb.append(" evaluations: ").append(toIndentedString(evaluations)).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 ");
}
}
