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.numberinsight2;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.JsonableBaseObject;
020
021/**
022 * Represents details of the phone number in {@link FraudCheckResponse#getPhone()}.
023 */
024public class Phone extends JsonableBaseObject {
025        private String number, carrier;
026        private PhoneType type;
027
028        protected Phone() {}
029
030        /**
031         * Phone number used in the fraud check operation(s).
032         * 
033         * @return The phone number in E.164 format.
034         */
035        @JsonProperty("phone")
036        public String getNumber() {
037                return number;
038        }
039
040        /**
041         * Name of the network carrier, if {@linkplain Insight#FRAUD_SCORE} was requested.
042         * 
043         * @return The network carrier name, or {@code null} if not applicable.
044         */
045        @JsonProperty("carrier")
046        public String getCarrier() {
047                return carrier;
048        }
049
050        /**
051         * Type of phone, if {@linkplain Insight#FRAUD_SCORE} was requested.
052         * 
053         * @return The phone type as an enum, or {@code null} if not applicable.
054         */
055        @JsonProperty("type")
056        public PhoneType getType() {
057                return type;
058        }
059}