001/*
002 *   Copyright 2020 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.numbers;
017
018import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
019import com.fasterxml.jackson.databind.ObjectMapper;
020import com.vonage.client.VonageUnexpectedException;
021
022import java.io.IOException;
023
024/**
025 * Represents the response to a "searchNumbers" request from the Vonage API.
026 */
027@JsonIgnoreProperties(ignoreUnknown = true)
028public class SearchNumbersResponse {
029    private int count = 0;
030    private AvailableNumber[] numbers = new AvailableNumber[]{};
031
032    /**
033     * Get the number of responses returned by the Vonage API.
034     */
035    public int getCount() {
036        return count;
037    }
038
039    /**
040     * Obtain an array of matching numbers than are available to buy.
041     */
042    public AvailableNumber[] getNumbers() {
043        return numbers;
044    }
045
046    public static SearchNumbersResponse fromJson(String json) {
047        try {
048            ObjectMapper mapper = new ObjectMapper();
049            return mapper.readValue(json, SearchNumbersResponse.class);
050        } catch (IOException jpe) {
051            throw new VonageUnexpectedException("Failed to produce json from SearchNumbersResponse object.", jpe);
052        }
053    }
054
055}