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.insight;
023
024import com.nexmo.client.HttpWrapper;
025import com.nexmo.client.NexmoClient;
026import com.nexmo.client.NexmoClientException;
027import com.nexmo.client.insight.advanced.AdvancedInsightEndpoint;
028import com.nexmo.client.insight.advanced.AdvancedInsightRequest;
029import com.nexmo.client.insight.advanced.AdvancedInsightResponse;
030import com.nexmo.client.insight.basic.BasicInsightEndpoint;
031import com.nexmo.client.insight.basic.BasicInsightRequest;
032import com.nexmo.client.insight.basic.BasicInsightResponse;
033import com.nexmo.client.insight.standard.StandardInsightEndpoint;
034import com.nexmo.client.insight.standard.StandardInsightRequest;
035import com.nexmo.client.insight.standard.StandardInsightResponse;
036
037import java.io.IOException;
038
039/**
040 * A client for talking to the Nexmo Number Insight API. The standard way to obtain an instance of this class is to use
041 * {@link NexmoClient#getInsightClient()}.
042 */
043public class InsightClient {
044    protected BasicInsightEndpoint basic;
045    protected StandardInsightEndpoint standard;
046    protected AdvancedInsightEndpoint advanced;
047
048    /**
049     * Constructor.
050     *
051     * @param httpWrapper (required) shared HTTP wrapper object used for making REST calls.
052     */
053    public InsightClient(HttpWrapper httpWrapper) {
054        this.basic = new BasicInsightEndpoint(httpWrapper);
055        this.standard = new StandardInsightEndpoint(httpWrapper);
056        this.advanced = new AdvancedInsightEndpoint(httpWrapper);
057    }
058
059    public BasicInsightResponse getBasicNumberInsight(String number) throws IOException, NexmoClientException {
060        return this.basic.execute(new BasicInsightRequest(number));
061    }
062
063    public BasicInsightResponse getBasicNumberInsight(String number, String country) throws IOException,
064                                                                                            NexmoClientException {
065        return this.basic.execute(new BasicInsightRequest(number, country));
066    }
067
068    public StandardInsightResponse getStandardNumberInsight(String number) throws IOException, NexmoClientException {
069        return this.standard.execute(new StandardInsightRequest(number));
070    }
071
072    public StandardInsightResponse getStandardNumberInsight(
073            String number, String country) throws IOException, NexmoClientException {
074        return this.standard.execute(new StandardInsightRequest(number, country));
075    }
076
077    public StandardInsightResponse getStandardNumberInsight(
078            String number, String country, boolean cnam) throws IOException, NexmoClientException {
079        return this.standard.execute(new StandardInsightRequest(number, country, cnam));
080    }
081
082    public AdvancedInsightResponse getAdvancedNumberInsight(String number) throws IOException, NexmoClientException {
083        return this.advanced.execute(new AdvancedInsightRequest(number));
084    }
085
086    public AdvancedInsightResponse getAdvancedNumberInsight(
087            String number, String country) throws IOException, NexmoClientException {
088        return this.advanced.execute(new AdvancedInsightRequest(number, country));
089    }
090
091    public AdvancedInsightResponse getAdvancedNumberInsight(
092            String number, String country, String ipAddress) throws IOException, NexmoClientException {
093        return this.advanced.execute(new AdvancedInsightRequest(number, country, ipAddress));
094    }
095
096    public AdvancedInsightResponse getAdvancedNumberInsight(
097            String number, String country, String ipAddress, boolean cnam) throws IOException, NexmoClientException {
098        return this.advanced.execute(new AdvancedInsightRequest(number, country, ipAddress, cnam));
099    }
100}