com.twilio.rest.taskrouter.v1.workspace.worker.WorkersStatisticsFetcher Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of common-thirdparty.twilio
The parent for all OSGi wrapped third party libraries
There is a newer version: 7.47.6
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.taskrouter.v1.workspace.worker;

import com.twilio.base.Fetcher;
import com.twilio.converter.DateConverter;
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 org.joda.time.DateTime;

public class WorkersStatisticsFetcher extends Fetcher {
    private final String pathWorkspaceSid;
    private Integer minutes;
    private DateTime startDate;
    private DateTime endDate;
    private String taskQueueSid;
    private String taskQueueName;
    private String friendlyName;
    private String taskChannel;

    /**
     * Construct a new WorkersStatisticsFetcher.
     * 
     * @param pathWorkspaceSid The workspace_sid
     */
    public WorkersStatisticsFetcher(final String pathWorkspaceSid) {
        this.pathWorkspaceSid = pathWorkspaceSid;
    }

    /**
     * Filter cumulative statistics by up to 'x' minutes in the past. This is
     * helpful for statistics for the last 15 minutes, 240 minutes (4 hours), and
     * 480 minutes (8 hours) to see trends. Defaults to 15 minutes..
     * 
     * @param minutes Filter cumulative statistics by up to 'x' minutes in the past.
     * @return this
     */
    public WorkersStatisticsFetcher setMinutes(final Integer minutes) {
        this.minutes = minutes;
        return this;
    }

    /**
     * Filter cumulative statistics by a start date. This is helpful for defining a
     * range of statistics to capture. Input is a string of the format:
     * yyyy-MM-dd'T'HH:mm:ss'Z'..
     * 
     * @param startDate Filter cumulative statistics by a start date.
     * @return this
     */
    public WorkersStatisticsFetcher setStartDate(final DateTime startDate) {
        this.startDate = startDate;
        return this;
    }

    /**
     * Filter cumulative statistics by a end date. This is helpful for defining a
     * range of statistics to capture. Input is a string of the format:
     * yyyy-MM-dd'T'HH:mm:ss'Z'..
     * 
     * @param endDate Filter cumulative statistics by a end date.
     * @return this
     */
    public WorkersStatisticsFetcher setEndDate(final DateTime endDate) {
        this.endDate = endDate;
        return this;
    }

    /**
     * Filter the real-time and cumulative statistics based on Workers tied to a
     * particular queue.
     * 
     * @param taskQueueSid Filter the real-time and cumulative statistics based on
     *                     Workers tied to a particular queue
     * @return this
     */
    public WorkersStatisticsFetcher setTaskQueueSid(final String taskQueueSid) {
        this.taskQueueSid = taskQueueSid;
        return this;
    }

    /**
     * Filter the real-time and cumulative statistics based on Workers tied to a
     * particular queue.
     * 
     * @param taskQueueName Filter the real-time and cumulative statistics based on
     *                      Workers tied to a particular queue
     * @return this
     */
    public WorkersStatisticsFetcher setTaskQueueName(final String taskQueueName) {
        this.taskQueueName = taskQueueName;
        return this;
    }

    /**
     * The friendly_name.
     * 
     * @param friendlyName The friendly_name
     * @return this
     */
    public WorkersStatisticsFetcher setFriendlyName(final String friendlyName) {
        this.friendlyName = friendlyName;
        return this;
    }

    /**
     * Filter cumulative statistics by TaskChannel. Takes in a Unique Name ("voice",
     * "sms", "default", etc.) or a TaskChannelSid..
     * 
     * @param taskChannel Filter cumulative statistics by TaskChannel.
     * @return this
     */
    public WorkersStatisticsFetcher setTaskChannel(final String taskChannel) {
        this.taskChannel = taskChannel;
        return this;
    }

    /**
     * Make the request to the Twilio API to perform the fetch.
     * 
     * @param client TwilioRestClient with which to make the request
     * @return Fetched WorkersStatistics
     */
    @Override
    @SuppressWarnings("checkstyle:linelength")
    public WorkersStatistics fetch(final TwilioRestClient client) {
        Request request = new Request(
            HttpMethod.GET,
            Domains.TASKROUTER.toString(),
            "/v1/Workspaces/" + this.pathWorkspaceSid + "/Workers/Statistics",
            client.getRegion()
        );

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

        if (response == null) {
            throw new ApiConnectionException("WorkersStatistics fetch 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 WorkersStatistics.fromJson(response.getStream(), client.getObjectMapper());
    }

    /**
     * Add the requested query string arguments to the Request.
     * 
     * @param request Request to add query string arguments to
     */
    private void addQueryParams(final Request request) {
        if (minutes != null) {
            request.addQueryParam("Minutes", minutes.toString());
        }

        if (startDate != null) {
            request.addQueryParam("StartDate", startDate.toString());
        }

        if (endDate != null) {
            request.addQueryParam("EndDate", endDate.toString());
        }

        if (taskQueueSid != null) {
            request.addQueryParam("TaskQueueSid", taskQueueSid);
        }

        if (taskQueueName != null) {
            request.addQueryParam("TaskQueueName", taskQueueName);
        }

        if (friendlyName != null) {
            request.addQueryParam("FriendlyName", friendlyName);
        }

        if (taskChannel != null) {
            request.addQueryParam("TaskChannel", taskChannel);
        }
    }
}