com.twilio.rest.verify.v2.service.entity.FactorCreator 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.verify.v2.service.entity;
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;
/**
* PLEASE NOTE that this class contains preview products that are subject to
* change. Use them with caution. If you currently do not have developer preview
* access, please contact [email protected].
*/
public class FactorCreator extends Creator {
private final String pathServiceSid;
private final String pathIdentity;
private final String binding;
private final String friendlyName;
private final Factor.FactorTypes factorType;
private final String config;
private String twilioSandboxMode;
/**
* Construct a new FactorCreator.
*
* @param pathServiceSid Service Sid.
* @param pathIdentity Unique external identifier of the Entity
* @param binding A unique binding for this Factor as a json string
* @param friendlyName The friendly name of this Factor
* @param factorType The Type of this Factor
* @param config The config for this Factor as a json string
*/
public FactorCreator(final String pathServiceSid,
final String pathIdentity,
final String binding,
final String friendlyName,
final Factor.FactorTypes factorType,
final String config) {
this.pathServiceSid = pathServiceSid;
this.pathIdentity = pathIdentity;
this.binding = binding;
this.friendlyName = friendlyName;
this.factorType = factorType;
this.config = config;
}
/**
* The Twilio-Sandbox-Mode HTTP request header.
*
* @param twilioSandboxMode The Twilio-Sandbox-Mode HTTP request header
* @return this
*/
public FactorCreator setTwilioSandboxMode(final String twilioSandboxMode) {
this.twilioSandboxMode = twilioSandboxMode;
return this;
}
/**
* Make the request to the Twilio API to perform the create.
*
* @param client TwilioRestClient with which to make the request
* @return Created Factor
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Factor create(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.POST,
Domains.VERIFY.toString(),
"/v2/Services/" + this.pathServiceSid + "/Entities/" + this.pathIdentity + "/Factors"
);
addPostParams(request);
addHeaderParams(request);
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("Factor creation failed: Unable to connect to server");
} else if (!TwilioRestClient.SUCCESS.test(response.getStatusCode())) {
RestException restException = RestException.fromJson(response.getStream(), client.getObjectMapper());
if (restException == null) {
throw new ApiException("Server Error, no content");
}
throw new ApiException(restException);
}
return Factor.fromJson(response.getStream(), client.getObjectMapper());
}
/**
* Add the requested header parameters to the Request.
*
* @param request Request to add header params to
*/
private void addHeaderParams(final Request request) {
if (twilioSandboxMode != null) {
request.addHeaderParam("Twilio-Sandbox-Mode", twilioSandboxMode);
}
}
/**
* Add the requested post parameters to the Request.
*
* @param request Request to add post params to
*/
private void addPostParams(final Request request) {
if (binding != null) {
request.addPostParam("Binding", binding);
}
if (friendlyName != null) {
request.addPostParam("FriendlyName", friendlyName);
}
if (factorType != null) {
request.addPostParam("FactorType", factorType.toString());
}
if (config != null) {
request.addPostParam("Config", config);
}
}
}