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