com.twilio.rest.studio.v1.flow.EngagementCreator Maven / Gradle / Ivy

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.1.5
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.studio.v1.flow;

import com.twilio.base.Creator;
import com.twilio.converter.Converter;
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.util.Map;

public class EngagementCreator extends Creator {
    private final String pathFlowSid;
    private final com.twilio.type.PhoneNumber to;
    private final com.twilio.type.PhoneNumber from;
    private Map parameters;

    /**
     * Construct a new EngagementCreator.
     *
     * @param pathFlowSid The SID of the Flow
     * @param to The Contact phone number to start a Studio Flow Engagement
     * @param from The Twilio phone number to send messages or initiate calls from
     *             during the Flow Engagement
     */
    public EngagementCreator(final String pathFlowSid,
                             final com.twilio.type.PhoneNumber to,
                             final com.twilio.type.PhoneNumber from) {
        this.pathFlowSid = pathFlowSid;
        this.to = to;
        this.from = from;
    }

    /**
     * A JSON string we will add to your flow's context and that you can access as
     * variables inside your flow. For example, if you pass in
     * `Parameters={'name':'Zeke'}` then inside a widget you can reference the
     * variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the
     * JSON value must explicitly be passed as a string, not as a hash object.
     * Depending on your particular HTTP library, you may need to add quotes or URL
     * encode your JSON string..
     *
     * @param parameters A JSON string we will add to your flow's context and that
     *                   you can access as variables inside your flow
     * @return this
     */
    public EngagementCreator setParameters(final Map parameters) {
        this.parameters = parameters;
        return this;
    }

    /**
     * Make the request to the Twilio API to perform the create.
     *
     * @param client TwilioRestClient with which to make the request
     * @return Created Engagement
     */
    @Override
    @SuppressWarnings("checkstyle:linelength")
    public Engagement create(final TwilioRestClient client) {
        Request request = new Request(
            HttpMethod.POST,
            Domains.STUDIO.toString(),
            "/v1/Flows/" + this.pathFlowSid + "/Engagements"
        );

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

        if (response == null) {
            throw new ApiConnectionException("Engagement 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 Engagement.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 (to != null) {
            request.addPostParam("To", to.toString());
        }

        if (from != null) {
            request.addPostParam("From", from.toString());
        }

        if (parameters != null) {
            request.addPostParam("Parameters", Converter.mapToJson(parameters));
        }
    }
}