com.twilio.rest.ipmessaging.v2.service.UserCreator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Show all versions of twilio Show documentation
Twilio Java Helper Library
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.ipmessaging.v2.service;
import com.twilio.base.Creator;
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 UserCreator extends Creator {
private final String pathServiceSid;
private final String identity;
private String roleSid;
private String attributes;
private String friendlyName;
/**
* Construct a new UserCreator.
*
* @param pathServiceSid Sid of the Service this user belongs to.
* @param identity A unique string that identifies the user within this service
* - often a username or email address.
*/
public UserCreator(final String pathServiceSid,
final String identity) {
this.pathServiceSid = pathServiceSid;
this.identity = identity;
}
/**
* The unique id of the [Role](https://www.twilio.com/docs/api/chat/rest/roles)
* assigned to this user..
*
* @param roleSid The unique id of the Role assigned to this user.
* @return this
*/
public UserCreator 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 UserCreator 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 UserCreator setFriendlyName(final String friendlyName) {
this.friendlyName = friendlyName;
return this;
}
/**
* Make the request to the Twilio API to perform the create.
*
* @param client TwilioRestClient with which to make the request
* @return Created User
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public User create(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.POST,
Domains.IPMESSAGING.toString(),
"/v2/Services/" + this.pathServiceSid + "/Users",
client.getRegion()
);
addPostParams(request);
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("User creation 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 (identity != null) {
request.addPostParam("Identity", identity);
}
if (roleSid != null) {
request.addPostParam("RoleSid", roleSid);
}
if (attributes != null) {
request.addPostParam("Attributes", attributes);
}
if (friendlyName != null) {
request.addPostParam("FriendlyName", friendlyName);
}
}
}