All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.twilio.rest.trunking.v1.TrunkUpdater Maven / Gradle / Ivy

There is a newer version: 10.7.0
Show newest version
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.trunking.v1;

import com.twilio.base.Updater;
import com.twilio.converter.Promoter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;

import java.net.URI;

public class TrunkUpdater extends Updater {
    private final String pathSid;
    private String friendlyName;
    private String domainName;
    private URI disasterRecoveryUrl;
    private HttpMethod disasterRecoveryMethod;
    private Trunk.RecordingSetting recording;
    private Boolean secure;
    private Boolean cnamLookupEnabled;

    /**
     * Construct a new TrunkUpdater.
     * 
     * @param pathSid The sid
     */
    public TrunkUpdater(final String pathSid) {
        this.pathSid = pathSid;
    }

    /**
     * A human-readable name for the Trunk..
     * 
     * @param friendlyName A human-readable name for the Trunk.
     * @return this
     */
    public TrunkUpdater setFriendlyName(final String friendlyName) {
        this.friendlyName = friendlyName;
        return this;
    }

    /**
     * The unique address you reserve on Twilio to which you route your SIP traffic.
     * Domain names can contain letters, digits, and `-` and must always end with
     * `pstn.twilio.com`. See [Termination
     * Settings](https://www.twilio.com/docs/sip-trunking/getting-started#termination) for more information..
     * 
     * @param domainName The unique address you reserve on Twilio to which you
     *                   route your SIP traffic.
     * @return this
     */
    public TrunkUpdater setDomainName(final String domainName) {
        this.domainName = domainName;
        return this;
    }

    /**
     * The HTTP URL that Twilio will request if an error occurs while sending SIP
     * traffic towards your configured Origination URL. Twilio will retrieve TwiML
     * from this URL and execute those instructions like any other normal TwiML
     * call. See [Disaster
     * Recovery](https://www.twilio.com/docs/sip-trunking/getting-started#disaster-recovery) for more information..
     * 
     * @param disasterRecoveryUrl The HTTP URL that Twilio will request if an error
     *                            occurs while sending SIP traffic towards your
     *                            configured Origination URL.
     * @return this
     */
    public TrunkUpdater setDisasterRecoveryUrl(final URI disasterRecoveryUrl) {
        this.disasterRecoveryUrl = disasterRecoveryUrl;
        return this;
    }

    /**
     * The HTTP URL that Twilio will request if an error occurs while sending SIP
     * traffic towards your configured Origination URL. Twilio will retrieve TwiML
     * from this URL and execute those instructions like any other normal TwiML
     * call. See [Disaster
     * Recovery](https://www.twilio.com/docs/sip-trunking/getting-started#disaster-recovery) for more information..
     * 
     * @param disasterRecoveryUrl The HTTP URL that Twilio will request if an error
     *                            occurs while sending SIP traffic towards your
     *                            configured Origination URL.
     * @return this
     */
    public TrunkUpdater setDisasterRecoveryUrl(final String disasterRecoveryUrl) {
        return setDisasterRecoveryUrl(Promoter.uriFromString(disasterRecoveryUrl));
    }

    /**
     * The HTTP method Twilio will use when requesting the `DisasterRecoveryUrl`.
     * Either `GET` or `POST`..
     * 
     * @param disasterRecoveryMethod The HTTP method Twilio will use when
     *                               requesting the DisasterRecoveryUrl.
     * @return this
     */
    public TrunkUpdater setDisasterRecoveryMethod(final HttpMethod disasterRecoveryMethod) {
        this.disasterRecoveryMethod = disasterRecoveryMethod;
        return this;
    }

    /**
     * The recording settings for this trunk. If turned on, all calls going through
     * this trunk will be recorded and the recording can either start when the call
     * is ringing or when the call is answered. See
     * [Recording](https://www.twilio.com/docs/sip-trunking/getting-started#recording) for more information..
     * 
     * @param recording The recording settings for this trunk.
     * @return this
     */
    public TrunkUpdater setRecording(final Trunk.RecordingSetting recording) {
        this.recording = recording;
        return this;
    }

    /**
     * The Secure Trunking  settings for this trunk. If turned on, all calls going
     * through this trunk will be secure using SRTP for media and TLS for
     * signalling. If turned off, then RTP will be used for media. See [Secure
     * Trunking](https://www.twilio.com/docs/sip-trunking/getting-started#securetrunking) for more information..
     * 
     * @param secure The Secure Trunking  settings for this trunk.
     * @return this
     */
    public TrunkUpdater setSecure(final Boolean secure) {
        this.secure = secure;
        return this;
    }

    /**
     * The Caller ID Name (CNAM) lookup setting for this trunk. If turned on, all
     * inbound calls to this SIP Trunk from the United States and Canada will
     * automatically perform a CNAM Lookup and display Caller ID data on your phone.
     * See [CNAM](https://www.twilio.com/docs/sip-trunking#CNAM) Lookups for more
     * information..
     * 
     * @param cnamLookupEnabled The Caller ID Name (CNAM) lookup setting for this
     *                          trunk.
     * @return this
     */
    public TrunkUpdater setCnamLookupEnabled(final Boolean cnamLookupEnabled) {
        this.cnamLookupEnabled = cnamLookupEnabled;
        return this;
    }

    /**
     * Make the request to the Twilio API to perform the update.
     * 
     * @param client TwilioRestClient with which to make the request
     * @return Updated Trunk
     */
    @Override
    @SuppressWarnings("checkstyle:linelength")
    public Trunk update(final TwilioRestClient client) {
        Request request = new Request(
            HttpMethod.POST,
            Domains.TRUNKING.toString(),
            "/v1/Trunks/" + this.pathSid + "",
            client.getRegion()
        );

        addPostParams(request);
        Response response = client.request(request);

        if (response == null) {
            throw new ApiConnectionException("Trunk update failed: Unable to connect to server");
        } else if (!TwilioRestClient.SUCCESS.apply(response.getStatusCode())) {
            RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
            if (restException == null) {
                throw new ApiException("Server Error, no content");
            }

            throw new ApiException(
                restException.getMessage(),
                restException.getCode(),
                restException.getMoreInfo(),
                restException.getStatus(),
                null
            );
        }

        return Trunk.fromJson(response.getStream(), client.getObjectMapper());
    }

    /**
     * Add the requested post parameters to the Request.
     * 
     * @param request Request to add post params to
     */
    private void addPostParams(final Request request) {
        if (friendlyName != null) {
            request.addPostParam("FriendlyName", friendlyName);
        }

        if (domainName != null) {
            request.addPostParam("DomainName", domainName);
        }

        if (disasterRecoveryUrl != null) {
            request.addPostParam("DisasterRecoveryUrl", disasterRecoveryUrl.toString());
        }

        if (disasterRecoveryMethod != null) {
            request.addPostParam("DisasterRecoveryMethod", disasterRecoveryMethod.toString());
        }

        if (recording != null) {
            request.addPostParam("Recording", recording.toString());
        }

        if (secure != null) {
            request.addPostParam("Secure", secure.toString());
        }

        if (cnamLookupEnabled != null) {
            request.addPostParam("CnamLookupEnabled", cnamLookupEnabled.toString());
        }
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy