com.bandwidth.iris.sdk.model.Tns Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bandwidth-java-iris-sdk Show documentation
Java SDK for use with the IRIS API.
There is a newer version: 4.2.0
Show newest version
package com.bandwidth.iris.sdk.model;

import com.bandwidth.iris.sdk.IrisClient;
import com.bandwidth.iris.sdk.IrisClientException;
import com.bandwidth.iris.sdk.IrisPath;
import com.bandwidth.iris.sdk.IrisResponse;
import com.bandwidth.iris.sdk.utils.XmlUtils;

import java.util.Map;

public class Tns {

    /**
     * @param client
     * @param tn
     * @return Fully populated TelephoneNumberDetails
     * @throws Exception
     */
    public static TelephoneNumberDetails getTnDetails(IrisClient client, String tn) throws Exception {
        return client.get(client.buildModelUri(
                        new String[] { IrisPath.TNS_URI_PATH, tn, "tndetails" }),
                TelephoneNumberResponse.class).getTelephoneNumberDetails();
    }

    public static TelephoneNumbersResponse list(IrisClient client, Map query) throws Exception {
        return client.get(client.buildModelUri(
                new String[] { IrisPath.TNS_URI_PATH }, query), TelephoneNumbersResponse.class);
    }

    /**
     * Status check for TN
     *
     * @param client
     * @param tn
     * @return
     * @throws Exception
     */
    public static TelephoneNumberResponse checkStatus(IrisClient client, String tn) throws Exception {
        IrisResponse irisResponse = client.get(client.buildModelUri(new String[] { IrisPath.TNS_URI_PATH, tn }));
        //Have to manually parse for this error because of how it's returned
        if (irisResponse.getResponseBody().indexOf("ErrorResponse") != -1) {
            ErrorResponse errorResponse = XmlUtils.fromXml(irisResponse.getResponseBody(), ErrorResponse.class);
            throw new IrisClientException(errorResponse.getIrisStatus().getCode(),
                    errorResponse.getIrisStatus().getDescription());
        } else {
            return XmlUtils.fromXml(irisResponse.getResponseBody(), TelephoneNumberResponse.class);
        }
    }

    /**
     * @param client
     * @param tn
     * @return The associated site.  As of now assuming this is a single site as there is nothing in the response
     * to indicate that this could be an array
     * @throws Exception
     */
    public static Site getSite(IrisClient client, String tn) throws Exception {
        return client.get(client.buildModelUri(new String[] { IrisPath.TNS_URI_PATH, tn, "sites" }), Site.class);
    }

    /**
     * @param client
     * @param tn
     * @return The associated SipPeer.  As of now assuming this is a single sip peer as there is nothing in the response
     * to indicate that this could be an array
     * @throws Exception
     */
    public static SipPeer getSipPeer(IrisClient client, String tn) throws Exception {
        return client.get(client.buildModelUri(new String[] { IrisPath.TNS_URI_PATH, tn, "sippeers" }), SipPeer.class);
    }

    /**
     * @param client
     * @param tn
     * @return TelephoneNumberDetails with RateCenter and State elements populated ONLY
     * @throws Exception
     */
    public static TelephoneNumberDetails getRateCenter(IrisClient client, String tn) throws Exception {
        return client.get(client.buildModelUri(new String[] { IrisPath.TNS_URI_PATH, tn, "ratecenter" }),
                TelephoneNumberResponse.class).getTelephoneNumberDetails();
    }

    /**
     * @param client
     * @param tn
     * @return TelephoneNumberDetails with Lata populated ONLY
     * @throws Exception
     */
    public static TelephoneNumberDetails getLata(IrisClient client, String tn) throws Exception {
        return client.get(client.buildModelUri(new String[] { IrisPath.TNS_URI_PATH, tn, "lata" }),
                TelephoneNumberResponse.class).getTelephoneNumberDetails();
    }

}