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.voice;
017
018import com.fasterxml.jackson.annotation.JsonCreator;
019import com.fasterxml.jackson.annotation.JsonValue;
020
021/**
022 * Represents event substates for advanced machine detection in {@link EventWebhook#getMachineDetectionSubstate()}.
023 *
024 * @since 8.2.0
025 */
026public enum MachineDetectionStatus {
027
028        /**
029         * The beginning of the voice mail beep.
030         */
031        BEEP_START,
032
033        /**
034         * Beep wasn't received after waiting for the designated period.
035         */
036        BEEP_TIMEOUT,
037
038        /**
039         * Unmapped value.
040         */
041        UNKNOWN;
042
043        @JsonValue
044        @Override
045        public String toString() {
046                return name().toLowerCase();
047        }
048
049        @JsonCreator
050        public static MachineDetectionStatus fromString(String name) {
051                try {
052                        return MachineDetectionStatus.valueOf(name.toUpperCase());
053                }
054                catch (IllegalArgumentException ex) {
055                        return UNKNOWN;
056                }
057        }
058}