com.twilio.rest.api.v2010.account.OutgoingCallerIdUpdater Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Twilio Java Helper Library
There is a newer version: 10.7.0
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.api.v2010.account;

import com.twilio.base.Updater;
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;

public class OutgoingCallerIdUpdater extends Updater {
    private String pathAccountSid;
    private final String pathSid;
    private String friendlyName;

    /**
     * Construct a new OutgoingCallerIdUpdater.
     * 
     * @param pathSid Update by unique outgoing-caller-id Sid
     */
    public OutgoingCallerIdUpdater(final String pathSid) {
        this.pathSid = pathSid;
    }

    /**
     * Construct a new OutgoingCallerIdUpdater.
     * 
     * @param pathAccountSid The account_sid
     * @param pathSid Update by unique outgoing-caller-id Sid
     */
    public OutgoingCallerIdUpdater(final String pathAccountSid, 
                                   final String pathSid) {
        this.pathAccountSid = pathAccountSid;
        this.pathSid = pathSid;
    }

    /**
     * A human readable description of a Caller ID, with maximum length of 64
     * characters. Defaults to a nicely formatted version of the phone number..
     * 
     * @param friendlyName A human readable description of the caller ID
     * @return this
     */
    public OutgoingCallerIdUpdater setFriendlyName(final String friendlyName) {
        this.friendlyName = friendlyName;
        return this;
    }

    /**
     * Make the request to the Twilio API to perform the update.
     * 
     * @param client TwilioRestClient with which to make the request
     * @return Updated OutgoingCallerId
     */
    @Override
    @SuppressWarnings("checkstyle:linelength")
    public OutgoingCallerId update(final TwilioRestClient client) {
        this.pathAccountSid = this.pathAccountSid == null ? client.getAccountSid() : this.pathAccountSid;
        Request request = new Request(
            HttpMethod.POST,
            Domains.API.toString(),
            "/2010-04-01/Accounts/" + this.pathAccountSid + "/OutgoingCallerIds/" + this.pathSid + ".json",
            client.getRegion()
        );

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

        if (response == null) {
            throw new ApiConnectionException("OutgoingCallerId 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 OutgoingCallerId.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);
        }
    }
}