com.unblu.webapi.model.v3.ApprovalRequestMessageData Maven / Gradle / Ivy
Show all versions of models-v3 Show documentation
package com.unblu.webapi.model.v3;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
/**
* Special case of a `MultichoiceQuestionMessageData`.<br> It is send to approve a layer action inside a conversation.
*/
@ApiModel(description = "Special case of a `MultichoiceQuestionMessageData`.
It is send to approve a layer action inside a conversation.")
@JsonPropertyOrder({
ApprovalRequestMessageData.JSON_PROPERTY_$_TYPE,
ApprovalRequestMessageData.JSON_PROPERTY_ID,
ApprovalRequestMessageData.JSON_PROPERTY_CONVERSATION_ID,
ApprovalRequestMessageData.JSON_PROPERTY_EXTERNAL_MESSENGER_CHANNEL_ID,
ApprovalRequestMessageData.JSON_PROPERTY_ACCOUNT_ID,
ApprovalRequestMessageData.JSON_PROPERTY_SENDER_PERSON,
ApprovalRequestMessageData.JSON_PROPERTY_SENDER_PERSON_PRESENCE_ID,
ApprovalRequestMessageData.JSON_PROPERTY_SERVER_TIMESTAMP,
ApprovalRequestMessageData.JSON_PROPERTY_SEND_TIMESTAMP,
ApprovalRequestMessageData.JSON_PROPERTY_TYPE,
ApprovalRequestMessageData.JSON_PROPERTY_RECIPIENT_PERSON_IDS,
ApprovalRequestMessageData.JSON_PROPERTY_FALLBACK_TEXT,
ApprovalRequestMessageData.JSON_PROPERTY_ACTION_ID,
ApprovalRequestMessageData.JSON_PROPERTY_SOURCE_ID,
ApprovalRequestMessageData.JSON_PROPERTY_BOT_THREAD_ID,
ApprovalRequestMessageData.JSON_PROPERTY_INTERNAL,
ApprovalRequestMessageData.JSON_PROPERTY_REPLY_TO_MESSAGE_ID,
ApprovalRequestMessageData.JSON_PROPERTY_TEXT,
ApprovalRequestMessageData.JSON_PROPERTY_TEXT_TYPE,
ApprovalRequestMessageData.JSON_PROPERTY_OPTIONS,
ApprovalRequestMessageData.JSON_PROPERTY_ANSWER_STATUS,
})
@JsonAutoDetect(creatorVisibility = Visibility.NONE, fieldVisibility = Visibility.NONE, getterVisibility = Visibility.NONE, isGetterVisibility = Visibility.NONE, setterVisibility = Visibility.NONE)
public class ApprovalRequestMessageData implements MessageData {
/**
* Gets or Sets $type
*/
public enum TypeEnum {
APPROVALREQUESTMESSAGEDATA("ApprovalRequestMessageData");
private String value;
TypeEnum(String value) {
this.value = value;
}
@JsonValue
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
@JsonCreator
public static TypeEnum fromValue(String value) {
for (TypeEnum b : TypeEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
return TypeEnum.APPROVALREQUESTMESSAGEDATA;
}
}
public static final String JSON_PROPERTY_$_TYPE = "$_type";
@JsonProperty(JSON_PROPERTY_$_TYPE)
private TypeEnum $type = TypeEnum.APPROVALREQUESTMESSAGEDATA;
public static final String JSON_PROPERTY_ID = "id";
@JsonProperty(JSON_PROPERTY_ID)
private String id;
public static final String JSON_PROPERTY_CONVERSATION_ID = "conversationId";
@JsonProperty(JSON_PROPERTY_CONVERSATION_ID)
private String conversationId;
public static final String JSON_PROPERTY_EXTERNAL_MESSENGER_CHANNEL_ID = "externalMessengerChannelId";
@JsonProperty(JSON_PROPERTY_EXTERNAL_MESSENGER_CHANNEL_ID)
private String externalMessengerChannelId;
public static final String JSON_PROPERTY_ACCOUNT_ID = "accountId";
@JsonProperty(JSON_PROPERTY_ACCOUNT_ID)
private String accountId;
public static final String JSON_PROPERTY_SENDER_PERSON = "senderPerson";
@JsonProperty(JSON_PROPERTY_SENDER_PERSON)
private PersonData senderPerson = null;
public static final String JSON_PROPERTY_SENDER_PERSON_PRESENCE_ID = "senderPersonPresenceId";
@JsonProperty(JSON_PROPERTY_SENDER_PERSON_PRESENCE_ID)
private String senderPersonPresenceId;
public static final String JSON_PROPERTY_SERVER_TIMESTAMP = "serverTimestamp";
@JsonProperty(JSON_PROPERTY_SERVER_TIMESTAMP)
private Long serverTimestamp;
public static final String JSON_PROPERTY_SEND_TIMESTAMP = "sendTimestamp";
@JsonProperty(JSON_PROPERTY_SEND_TIMESTAMP)
private Long sendTimestamp;
public static final String JSON_PROPERTY_TYPE = "type";
@JsonProperty(JSON_PROPERTY_TYPE)
private EMessageType type = EMessageType.APPROVAL_REQUEST;
public static final String JSON_PROPERTY_RECIPIENT_PERSON_IDS = "recipientPersonIds";
@JsonProperty(JSON_PROPERTY_RECIPIENT_PERSON_IDS)
private List recipientPersonIds = null;
public static final String JSON_PROPERTY_FALLBACK_TEXT = "fallbackText";
@JsonProperty(JSON_PROPERTY_FALLBACK_TEXT)
private String fallbackText;
public static final String JSON_PROPERTY_ACTION_ID = "actionId";
@JsonProperty(JSON_PROPERTY_ACTION_ID)
private String actionId;
public static final String JSON_PROPERTY_SOURCE_ID = "sourceId";
@JsonProperty(JSON_PROPERTY_SOURCE_ID)
private String sourceId;
public static final String JSON_PROPERTY_BOT_THREAD_ID = "botThreadId";
@JsonProperty(JSON_PROPERTY_BOT_THREAD_ID)
private String botThreadId;
public static final String JSON_PROPERTY_INTERNAL = "internal";
@JsonProperty(JSON_PROPERTY_INTERNAL)
private Boolean internal;
public static final String JSON_PROPERTY_REPLY_TO_MESSAGE_ID = "replyToMessageId";
@JsonProperty(JSON_PROPERTY_REPLY_TO_MESSAGE_ID)
private String replyToMessageId;
public static final String JSON_PROPERTY_TEXT = "text";
@JsonProperty(JSON_PROPERTY_TEXT)
private String text;
public static final String JSON_PROPERTY_TEXT_TYPE = "textType";
@JsonProperty(JSON_PROPERTY_TEXT_TYPE)
private EConversationMessageTextType textType;
public static final String JSON_PROPERTY_OPTIONS = "options";
@JsonProperty(JSON_PROPERTY_OPTIONS)
private List options = null;
public static final String JSON_PROPERTY_ANSWER_STATUS = "answerStatus";
@JsonProperty(JSON_PROPERTY_ANSWER_STATUS)
private EAnswerStatus answerStatus;
public ApprovalRequestMessageData $type(TypeEnum $type) {
this.$type = $type;
return this;
}
/**
* Get $type
*
* @return $type
**/
@ApiModelProperty(value = "")
public TypeEnum get$Type() {
return $type;
}
public void set$Type(TypeEnum $type) {
this.$type = $type;
}
public ApprovalRequestMessageData id(String id) {
this.id = id;
return this;
}
/**
* The ID of the message<br>
*
* @return id
**/
@ApiModelProperty(value = "The ID of the message
")
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public ApprovalRequestMessageData conversationId(String conversationId) {
this.conversationId = conversationId;
return this;
}
/**
* Conversation ID this message belongs to
*
* @return conversationId
**/
@ApiModelProperty(value = "Conversation ID this message belongs to")
public String getConversationId() {
return conversationId;
}
public void setConversationId(String conversationId) {
this.conversationId = conversationId;
}
public ApprovalRequestMessageData externalMessengerChannelId(String externalMessengerChannelId) {
this.externalMessengerChannelId = externalMessengerChannelId;
return this;
}
/**
* ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger.
*
* @return externalMessengerChannelId
**/
@ApiModelProperty(value = "ID of the external messenger channel connected to the conversation. Null if the conversation is not connected to an external messenger.")
public String getExternalMessengerChannelId() {
return externalMessengerChannelId;
}
public void setExternalMessengerChannelId(String externalMessengerChannelId) {
this.externalMessengerChannelId = externalMessengerChannelId;
}
public ApprovalRequestMessageData accountId(String accountId) {
this.accountId = accountId;
return this;
}
/**
* ID of the account this message and conversation belong to
*
* @return accountId
**/
@ApiModelProperty(value = "ID of the account this message and conversation belong to")
public String getAccountId() {
return accountId;
}
public void setAccountId(String accountId) {
this.accountId = accountId;
}
public ApprovalRequestMessageData senderPerson(PersonData senderPerson) {
this.senderPerson = senderPerson;
return this;
}
/**
* Get senderPerson
*
* @return senderPerson
**/
@ApiModelProperty(value = "")
public PersonData getSenderPerson() {
return senderPerson;
}
public void setSenderPerson(PersonData senderPerson) {
this.senderPerson = senderPerson;
}
public ApprovalRequestMessageData senderPersonPresenceId(String senderPersonPresenceId) {
this.senderPersonPresenceId = senderPersonPresenceId;
return this;
}
/**
* ID of the person presence who sent the message. <p> May be null if the message was sent by the system.
*
* @return senderPersonPresenceId
**/
@ApiModelProperty(value = "ID of the person presence who sent the message. May be null if the message was sent by the system.")
public String getSenderPersonPresenceId() {
return senderPersonPresenceId;
}
public void setSenderPersonPresenceId(String senderPersonPresenceId) {
this.senderPersonPresenceId = senderPersonPresenceId;
}
public ApprovalRequestMessageData serverTimestamp(Long serverTimestamp) {
this.serverTimestamp = serverTimestamp;
return this;
}
/**
* UTC timestamp when the message was received by the server<br> Empty when sending a new message to the collaboration server
*
* @return serverTimestamp
**/
@ApiModelProperty(value = "UTC timestamp when the message was received by the server
Empty when sending a new message to the collaboration server")
public Long getServerTimestamp() {
return serverTimestamp;
}
public void setServerTimestamp(Long serverTimestamp) {
this.serverTimestamp = serverTimestamp;
}
public ApprovalRequestMessageData sendTimestamp(Long sendTimestamp) {
this.sendTimestamp = sendTimestamp;
return this;
}
/**
* UTC timestamp when the message was sent by the client.<br> Empty when sending a new message to the collaboration server
*
* @return sendTimestamp
**/
@ApiModelProperty(value = "UTC timestamp when the message was sent by the client.
Empty when sending a new message to the collaboration server")
public Long getSendTimestamp() {
return sendTimestamp;
}
public void setSendTimestamp(Long sendTimestamp) {
this.sendTimestamp = sendTimestamp;
}
public ApprovalRequestMessageData type(EMessageType type) {
this.type = type;
return this;
}
/**
* Get type
*
* @return type
**/
@ApiModelProperty(value = "")
public EMessageType getType() {
return type;
}
public void setType(EMessageType type) {
this.type = type;
}
public ApprovalRequestMessageData recipientPersonIds(List recipientPersonIds) {
this.recipientPersonIds = recipientPersonIds;
return this;
}
public ApprovalRequestMessageData addRecipientPersonIdsItem(String recipientPersonIdsItem) {
if (this.recipientPersonIds == null) {
this.recipientPersonIds = new ArrayList<>();
}
this.recipientPersonIds.add(recipientPersonIdsItem);
return this;
}
/**
* Person IDs of the recipients of the message. If null, all active participations are recipients.
*
* @return recipientPersonIds
**/
@ApiModelProperty(value = "Person IDs of the recipients of the message. If null, all active participations are recipients.")
public List getRecipientPersonIds() {
return recipientPersonIds;
}
public void setRecipientPersonIds(List recipientPersonIds) {
this.recipientPersonIds = recipientPersonIds;
}
public ApprovalRequestMessageData fallbackText(String fallbackText) {
this.fallbackText = fallbackText;
return this;
}
/**
* Text representation of the message which is used in following cases: <ul> <li>Unblu cannot restore the complex content of the message
* anymore</li> <li>Push notifications</li> <li>For the last message in the conversation overview</li> </ul> The text
* doesn't contain markdown.<br> The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. It may,
* however, not always be a perfect textual representation of the message.<br>
*
* @return fallbackText
**/
@ApiModelProperty(value = "Text representation of the message which is used in following cases: - Unblu cannot restore the complex content of the message anymore
- Push notifications
- For the last message in the conversation overview
The text doesn't contain markdown.
The fallback text can be provided by the sender (bot, external messenger) or is generated when missing. It may, however, not always be a perfect textual representation of the message.
")
public String getFallbackText() {
return fallbackText;
}
public void setFallbackText(String fallbackText) {
this.fallbackText = fallbackText;
}
public ApprovalRequestMessageData actionId(String actionId) {
this.actionId = actionId;
return this;
}
/**
* An ID of the action triggering the message to be able to identify a message created by an action
*
* @return actionId
**/
@ApiModelProperty(value = "An ID of the action triggering the message to be able to identify a message created by an action")
public String getActionId() {
return actionId;
}
public void setActionId(String actionId) {
this.actionId = actionId;
}
public ApprovalRequestMessageData sourceId(String sourceId) {
this.sourceId = sourceId;
return this;
}
/**
* A custom ID which identifies where this message initially came from
*
* @return sourceId
**/
@ApiModelProperty(value = "A custom ID which identifies where this message initially came from")
public String getSourceId() {
return sourceId;
}
public void setSourceId(String sourceId) {
this.sourceId = sourceId;
}
public ApprovalRequestMessageData botThreadId(String botThreadId) {
this.botThreadId = botThreadId;
return this;
}
/**
* An ID which identifies the bot thread this message belongs. Null if the message is not part of a bot thread.
*
* @return botThreadId
**/
@ApiModelProperty(value = "An ID which identifies the bot thread this message belongs. Null if the message is not part of a bot thread.")
public String getBotThreadId() {
return botThreadId;
}
public void setBotThreadId(String botThreadId) {
this.botThreadId = botThreadId;
}
public ApprovalRequestMessageData internal(Boolean internal) {
this.internal = internal;
return this;
}
/**
* Flag indicating whether the message is internal and only visible to agents. If 'false', the message is public and visible for everyone.
*
* @return internal
**/
@ApiModelProperty(value = "Flag indicating whether the message is internal and only visible to agents. If 'false', the message is public and visible for everyone.")
public Boolean isInternal() {
return internal;
}
public void setInternal(Boolean internal) {
this.internal = internal;
}
public ApprovalRequestMessageData replyToMessageId(String replyToMessageId) {
this.replyToMessageId = replyToMessageId;
return this;
}
/**
* Optional ID that identifies the message that this message is replying to
*
* @return replyToMessageId
**/
@ApiModelProperty(value = "Optional ID that identifies the message that this message is replying to")
public String getReplyToMessageId() {
return replyToMessageId;
}
public void setReplyToMessageId(String replyToMessageId) {
this.replyToMessageId = replyToMessageId;
}
public ApprovalRequestMessageData text(String text) {
this.text = text;
return this;
}
/**
* Text of the message
*
* @return text
**/
@ApiModelProperty(value = "Text of the message")
public String getText() {
return text;
}
public void setText(String text) {
this.text = text;
}
public ApprovalRequestMessageData textType(EConversationMessageTextType textType) {
this.textType = textType;
return this;
}
/**
* Get textType
*
* @return textType
**/
@ApiModelProperty(value = "")
public EConversationMessageTextType getTextType() {
return textType;
}
public void setTextType(EConversationMessageTextType textType) {
this.textType = textType;
}
public ApprovalRequestMessageData options(List options) {
this.options = options;
return this;
}
public ApprovalRequestMessageData addOptionsItem(MultichoiceQuestionOption optionsItem) {
if (this.options == null) {
this.options = new ArrayList<>();
}
this.options.add(optionsItem);
return this;
}
/**
* Response options for the question.<br> When replying to this question, the value of an option needs to be send in a `ReplyMessageData`
*
* @return options
**/
@ApiModelProperty(value = "Response options for the question.
When replying to this question, the value of an option needs to be send in a `ReplyMessageData`")
public List getOptions() {
return options;
}
public void setOptions(List options) {
this.options = options;
}
public ApprovalRequestMessageData answerStatus(EAnswerStatus answerStatus) {
this.answerStatus = answerStatus;
return this;
}
/**
* Get answerStatus
*
* @return answerStatus
**/
@ApiModelProperty(value = "")
public EAnswerStatus getAnswerStatus() {
return answerStatus;
}
public void setAnswerStatus(EAnswerStatus answerStatus) {
this.answerStatus = answerStatus;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ApprovalRequestMessageData approvalRequestMessageData = (ApprovalRequestMessageData) o;
return Objects.equals(this.$type, approvalRequestMessageData.$type) &&
Objects.equals(this.id, approvalRequestMessageData.id) &&
Objects.equals(this.conversationId, approvalRequestMessageData.conversationId) &&
Objects.equals(this.externalMessengerChannelId, approvalRequestMessageData.externalMessengerChannelId) &&
Objects.equals(this.accountId, approvalRequestMessageData.accountId) &&
Objects.equals(this.senderPerson, approvalRequestMessageData.senderPerson) &&
Objects.equals(this.senderPersonPresenceId, approvalRequestMessageData.senderPersonPresenceId) &&
Objects.equals(this.serverTimestamp, approvalRequestMessageData.serverTimestamp) &&
Objects.equals(this.sendTimestamp, approvalRequestMessageData.sendTimestamp) &&
Objects.equals(this.type, approvalRequestMessageData.type) &&
Objects.equals(this.recipientPersonIds, approvalRequestMessageData.recipientPersonIds) &&
Objects.equals(this.fallbackText, approvalRequestMessageData.fallbackText) &&
Objects.equals(this.actionId, approvalRequestMessageData.actionId) &&
Objects.equals(this.sourceId, approvalRequestMessageData.sourceId) &&
Objects.equals(this.botThreadId, approvalRequestMessageData.botThreadId) &&
Objects.equals(this.internal, approvalRequestMessageData.internal) &&
Objects.equals(this.replyToMessageId, approvalRequestMessageData.replyToMessageId) &&
Objects.equals(this.text, approvalRequestMessageData.text) &&
Objects.equals(this.textType, approvalRequestMessageData.textType) &&
Objects.equals(this.options, approvalRequestMessageData.options) &&
Objects.equals(this.answerStatus, approvalRequestMessageData.answerStatus);
}
@Override
public int hashCode() {
return Objects.hash($type, id, conversationId, externalMessengerChannelId, accountId, senderPerson, senderPersonPresenceId, serverTimestamp, sendTimestamp, type, recipientPersonIds, fallbackText, actionId, sourceId, botThreadId, internal, replyToMessageId, text, textType, options, answerStatus);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class ApprovalRequestMessageData {\n");
sb.append(" $type: ").append(toIndentedString($type)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" conversationId: ").append(toIndentedString(conversationId)).append("\n");
sb.append(" externalMessengerChannelId: ").append(toIndentedString(externalMessengerChannelId)).append("\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" senderPerson: ").append(toIndentedString(senderPerson)).append("\n");
sb.append(" senderPersonPresenceId: ").append(toIndentedString(senderPersonPresenceId)).append("\n");
sb.append(" serverTimestamp: ").append(toIndentedString(serverTimestamp)).append("\n");
sb.append(" sendTimestamp: ").append(toIndentedString(sendTimestamp)).append("\n");
sb.append(" type: ").append(toIndentedString(type)).append("\n");
sb.append(" recipientPersonIds: ").append(toIndentedString(recipientPersonIds)).append("\n");
sb.append(" fallbackText: ").append(toIndentedString(fallbackText)).append("\n");
sb.append(" actionId: ").append(toIndentedString(actionId)).append("\n");
sb.append(" sourceId: ").append(toIndentedString(sourceId)).append("\n");
sb.append(" botThreadId: ").append(toIndentedString(botThreadId)).append("\n");
sb.append(" internal: ").append(toIndentedString(internal)).append("\n");
sb.append(" replyToMessageId: ").append(toIndentedString(replyToMessageId)).append("\n");
sb.append(" text: ").append(toIndentedString(text)).append("\n");
sb.append(" textType: ").append(toIndentedString(textType)).append("\n");
sb.append(" options: ").append(toIndentedString(options)).append("\n");
sb.append(" answerStatus: ").append(toIndentedString(answerStatus)).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 ");
}
}