com.twilio.rest.ipmessaging.v1.service.UserUpdater Maven / Gradle / Ivy
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.ipmessaging.v1.service;
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 UserUpdater extends Updater {
private final String pathServiceSid;
private final String pathSid;
private String roleSid;
private String attributes;
private String friendlyName;
/**
* Construct a new UserUpdater.
*
* @param pathServiceSid The service_sid
* @param pathSid The sid
*/
public UserUpdater(final String pathServiceSid,
final String pathSid) {
this.pathServiceSid = pathServiceSid;
this.pathSid = pathSid;
}
/**
* The unique id of the [Role][role] assigned to this user..
*
* @param roleSid The unique id of the [Role][role] assigned to this user.
* @return this
*/
public UserUpdater setRoleSid(final String roleSid) {
this.roleSid = roleSid;
return this;
}
/**
* An optional string used to contain any metadata or other information for the
* User. The string must contain structurally valid JSON if specified..
*
* @param attributes An optional string used to contain any metadata or other
* information for the User.
* @return this
*/
public UserUpdater setAttributes(final String attributes) {
this.attributes = attributes;
return this;
}
/**
* An optional human readable string representing the user. Often used for
* display purposes..
*
* @param friendlyName An optional human readable string representing the user.
* @return this
*/
public UserUpdater 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 User
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public User update(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.POST,
Domains.IPMESSAGING.toString(),
"/v1/Services/" + this.pathServiceSid + "/Users/" + this.pathSid + "",
client.getRegion()
);
addPostParams(request);
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("User 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 User.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 (roleSid != null) {
request.addPostParam("RoleSid", roleSid);
}
if (attributes != null) {
request.addPostParam("Attributes", attributes);
}
if (friendlyName != null) {
request.addPostParam("FriendlyName", friendlyName);
}
}
}