001/*
002 * Copyright (c) 2011-2018 Nexmo Inc
003 *
004 * Permission is hereby granted, free of charge, to any person obtaining a copy
005 * of this software and associated documentation files (the "Software"), to deal
006 * in the Software without restriction, including without limitation the rights
007 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
008 * copies of the Software, and to permit persons to whom the Software is
009 * furnished to do so, subject to the following conditions:
010 *
011 * The above copyright notice and this permission notice shall be included in
012 * all copies or substantial portions of the Software.
013 *
014 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
015 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
016 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
017 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
018 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
019 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
020 * THE SOFTWARE.
021 */
022package com.nexmo.client.verify;
023
024import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
025
026import java.util.HashMap;
027import java.util.Map;
028
029@JsonDeserialize(using = VerifyStatusDeserializer.class)
030public enum VerifyStatus {
031    OK(0),
032    THROTTLED(1),
033    MISSING_PARAMS(2),
034    INVALID_PARAMS(3),
035    INVALID_CREDENTIALS(4),
036    INTERNAL_ERROR(5),
037    INVALID_REQUEST(6),
038    NUMBER_BARRED(7),
039    PARTNER_ACCOUNT_BARRED(8),
040    PARTNER_QUOTA_EXCEEDED(9),
041    ALREADY_REQUESTED(10),
042    UNSUPPORTED_NETWORK(15),
043    INVALID_CODE(16),
044    WRONG_CODE_THROTTLED(17),
045    TOO_MANY_DESTINATIONS(18),
046    NO_RESPONSE(101), COMMS_FAILURE(-1), UNKNOWN(Integer.MAX_VALUE);
047
048    private int verifyStatus;
049
050    private static final Map<Integer, VerifyStatus> VERIFY_STATUS_INDEX = new HashMap<>();
051
052    static {
053        for (VerifyStatus verifyStatus : VerifyStatus.values()) {
054            VERIFY_STATUS_INDEX.put(verifyStatus.verifyStatus, verifyStatus);
055        }
056    }
057
058    /**
059     * Look up the {@link VerifyStatus} based on the int value.
060     *
061     * @param verifyStatus the int value of the verify status.
062     *
063     * @return VerifyStatus based on the int value given.
064     */
065    public static VerifyStatus fromInt(int verifyStatus) {
066        VerifyStatus foundVerifyStatus = VERIFY_STATUS_INDEX.get(verifyStatus);
067        return (foundVerifyStatus != null) ? foundVerifyStatus : UNKNOWN;
068    }
069
070    VerifyStatus(int verifyStatus) {
071        this.verifyStatus = verifyStatus;
072    }
073
074    public int getVerifyStatus() {
075        return this.verifyStatus;
076    }
077
078    public boolean isTemporaryError() {
079        return this == THROTTLED || this == INTERNAL_ERROR;
080    }
081}