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.insight;
017
018import com.fasterxml.jackson.annotation.JsonCreator;
019
020/**
021 * Represents the type of the number's owner as an enum.
022 * The value will be {@code BUSINESS} if the owner of a phone number is a business.
023 * If the owner is an individual the value will be {@code CONSUMER}.
024 * The value will be {@code UNKNOWN} if this information is not available.
025 * This parameter is only present if cnam had a value of {@code true} in the request.
026 */
027public enum CallerType {
028    BUSINESS,
029    CONSUMER,
030    UNKNOWN;
031
032    @JsonCreator
033    public static CallerType fromString(String name) {
034        try {
035            return CallerType.valueOf(name.toUpperCase());
036        }
037        catch (IllegalArgumentException iax) {
038            return UNKNOWN;
039        }
040    }
041
042    @Override
043    public String toString() {
044        return name().toLowerCase();
045    }
046}