001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.verify;
017
018import com.fasterxml.jackson.annotation.JsonCreator;
019import com.fasterxml.jackson.annotation.JsonValue;
020
021/**
022 * Enum representing the control command. The possible commands are {@code cancel} to request cancellation of
023 * the verification process, or {@code trigger_next_event} to advance to the next verification event (if any).
024 * Cancellation is only possible 30 seconds after the start of the verification request and
025 * before the second event (either TTS or SMS) has taken place.
026 */
027public enum VerifyControlCommand {
028    CANCEL,
029    TRIGGER_NEXT_EVENT;
030
031    @JsonValue
032    @Override
033    public String toString() {
034        return name().toLowerCase();
035    }
036
037    @JsonCreator
038    public static VerifyControlCommand fromString(String name) {
039        return VerifyControlCommand.valueOf(name.toUpperCase());
040    }
041}