001/*
002 * Copyright (c) 2011-2018 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.conversion;
023
024import com.nexmo.client.AbstractClient;
025import com.nexmo.client.HttpWrapper;
026import com.nexmo.client.NexmoClient;
027import com.nexmo.client.NexmoClientException;
028
029import java.io.IOException;
030import java.util.Date;
031
032/**
033 * A client for talking to the Nexmo Conversion API. The standard way to obtain an instance of this class is to use
034 * {@link NexmoClient#getConversionClient()}.
035 * <p>
036 * Allows you to tell Nexmo about the reliability of your 2FA communications.
037 * <p>
038 * More information on method parameters can be found at Nexmo website:
039 * <a href="https://developer.nexmo.com/messaging/conversion-api/overview">https://developer.nexmo.com/messaging/conversion-api/overview</a>
040 */
041public class ConversionClient extends AbstractClient {
042    private ConversionEndpoint conversionEndpoint;
043
044    public ConversionClient(HttpWrapper httpWrapper) {
045        super(httpWrapper);
046
047        this.conversionEndpoint = new ConversionEndpoint(httpWrapper);
048    }
049
050    /**
051     * Submit a request to the Conversion API indicating whether or not a message was delivered.
052     *
053     * @param type      The {@link ConversionRequest.Type} type of com.nexmo.client.conversion.
054     * @param messageId The id of the message that was sent.
055     * @param delivered A boolean indicating whether or not it was delivered.
056     * @param timestamp A timestamp of when it was known to be delivered.
057     * @throws IOException          if a network error occurred contacting the Nexmo Conversion API.
058     * @throws NexmoClientException if there was a problem with the Nexmo request or response objects.
059     */
060    public void submitConversion(ConversionRequest.Type type,
061                                 String messageId,
062                                 boolean delivered,
063                                 Date timestamp) throws IOException, NexmoClientException {
064        this.conversionEndpoint.submitConversion(new ConversionRequest(type, messageId, delivered, timestamp));
065    }
066}