com.unblu.webapi.model.v3.EConversationState Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of models-v3 Show documentation

Java classes corresponding to the JSON bodies

There is a newer version: 7.53.4


package com.unblu.webapi.model.v3;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;

/**
 * Life cycle state of the conversation. Following transitions are possible: <ul> <li>`CREATED` --> `ONBOARDING`,
 * `OFFBOARDING`</li> <li>`ONBOARDING` --> `QUEUED`, `ACTIVE`, `OFFBOARDING`,
 * `UNASSIGNED`</li> <li>`REBOARDING` --> `QUEUED`, `UNASSIGNED`, `OFFBOARDING`</li>
 * <li>`QUEUED` --> `ACTIVE`, `OFFBOARDING`, `UNASSIGNED`</li> <li>`ACTIVE` -->
 * `UNASSIGNED`, `OFFBOARDING`, `QUEUED`</li> <li>`UNASSIGNED` --> `REBOARDING`,
 * `OFFBOARDING`, `QUEUED`, `ACTIVE`</li> <li>`OFFBOARDING` --> `ENDED`</li>
 * <li>`ENDED` --> none</li> </ul>
 */
public enum EConversationState {

	/**
	 * CREATED: Initial state of a conversation
	 */
	CREATED("CREATED"),

	/**
	 * ONBOARDING: Depending of the engagement type of the conversation, the conversation stays in the onboarding state as long as the person in the center of the
	 * conversation is doing his onboarding
	 */
	ONBOARDING("ONBOARDING"),

	/**
	 * REBOARDING: When a message is send to an unassigned conversation, the conversation first is put into the reboarding state as long as the person in the center
	 * of the conversation is doing the reboarding.
	 */
	REBOARDING("REBOARDING"),

	/**
	 * QUEUED: Depending of the engagement type of the conversation, the conversation is put in the queued state when it is inside the queue.
	 */
	QUEUED("QUEUED"),

	/**
	 * ACTIVE: Conversation is active
	 */
	ACTIVE("ACTIVE"),

	/**
	 * UNASSIGNED: After there is no assignee of a conversation anymore, the conversation goes to unassigned state until a message from a visitor is written to
	 * start reboarding again, or until the conversation is requeued.
	 */
	UNASSIGNED("UNASSIGNED"),

	/**
	 * OFFBOARDING: Conversation is being ended
	 */
	OFFBOARDING("OFFBOARDING"),

	/**
	 * ENDED: Conversation is ended
	 */
	ENDED("ENDED");

	private String value;

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

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

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

	@JsonCreator
	public static EConversationState fromValue(String value) {
		for (EConversationState b : EConversationState.values()) {
			if (b.value.equals(value)) {
				return b;
			}
		}
		throw new IllegalArgumentException("Unexpected value '" + value + "'");
	}
}