com.twilio.rest.api.v2010.account.CallReader 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.api.v2010.account;
import com.google.common.collect.Range;
import com.twilio.base.Page;
import com.twilio.base.Reader;
import com.twilio.base.ResourceSet;
import com.twilio.converter.DateConverter;
import com.twilio.converter.Promoter;
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 CallReader extends Reader {
private String pathAccountSid;
private com.twilio.type.PhoneNumber to;
private com.twilio.type.PhoneNumber from;
private String parentCallSid;
private Call.Status status;
private DateTime absoluteStartTime;
private Range rangeStartTime;
private DateTime absoluteEndTime;
private Range rangeEndTime;
/**
* Construct a new CallReader.
*/
public CallReader() {
}
/**
* Construct a new CallReader.
*
* @param pathAccountSid The SID of the Account that created the resource(s) to
* read
*/
public CallReader(final String pathAccountSid) {
this.pathAccountSid = pathAccountSid;
}
/**
* Only show calls made to this phone number, SIP address, Client identifier or
* SIM SID..
*
* @param to Phone number or Client identifier of calls to include
* @return this
*/
public CallReader setTo(final com.twilio.type.PhoneNumber to) {
this.to = to;
return this;
}
/**
* Only show calls made to this phone number, SIP address, Client identifier or
* SIM SID..
*
* @param to Phone number or Client identifier of calls to include
* @return this
*/
public CallReader setTo(final String to) {
return setTo(Promoter.phoneNumberFromString(to));
}
/**
* Only include calls from this phone number, SIP address, Client identifier or
* SIM SID..
*
* @param from Phone number or Client identifier to filter `from` on
* @return this
*/
public CallReader setFrom(final com.twilio.type.PhoneNumber from) {
this.from = from;
return this;
}
/**
* Only include calls from this phone number, SIP address, Client identifier or
* SIM SID..
*
* @param from Phone number or Client identifier to filter `from` on
* @return this
*/
public CallReader setFrom(final String from) {
return setFrom(Promoter.phoneNumberFromString(from));
}
/**
* Only include calls spawned by calls with this SID..
*
* @param parentCallSid Parent call SID to filter on
* @return this
*/
public CallReader setParentCallSid(final String parentCallSid) {
this.parentCallSid = parentCallSid;
return this;
}
/**
* The status of the calls to include. Can be: `queued`, `ringing`,
* `in-progress`, `canceled`, `completed`, `failed`, `busy`, or `no-answer`..
*
* @param status The status of the resources to read
* @return this
*/
public CallReader setStatus(final Call.Status status) {
this.status = status;
return this;
}
/**
* Only include calls that started on this date. Specify a date as `YYYY-MM-DD`
* in GMT, for example: `2009-07-06`, to read only calls that started on this
* date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`,
* to read calls that started on or before midnight of this date, and
* `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of
* this date..
*
* @param absoluteStartTime Only include calls that started on this date
* @return this
*/
public CallReader setStartTime(final DateTime absoluteStartTime) {
this.rangeStartTime = null;
this.absoluteStartTime = absoluteStartTime;
return this;
}
/**
* Only include calls that started on this date. Specify a date as `YYYY-MM-DD`
* in GMT, for example: `2009-07-06`, to read only calls that started on this
* date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`,
* to read calls that started on or before midnight of this date, and
* `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of
* this date..
*
* @param rangeStartTime Only include calls that started on this date
* @return this
*/
public CallReader setStartTime(final Range rangeStartTime) {
this.absoluteStartTime = null;
this.rangeStartTime = rangeStartTime;
return this;
}
/**
* Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in
* GMT, for example: `2009-07-06`, to read only calls that ended on this date.
* You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read
* calls that ended on or before midnight of this date, and
* `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of
* this date..
*
* @param absoluteEndTime Only include calls that ended on this date
* @return this
*/
public CallReader setEndTime(final DateTime absoluteEndTime) {
this.rangeEndTime = null;
this.absoluteEndTime = absoluteEndTime;
return this;
}
/**
* Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in
* GMT, for example: `2009-07-06`, to read only calls that ended on this date.
* You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read
* calls that ended on or before midnight of this date, and
* `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of
* this date..
*
* @param rangeEndTime Only include calls that ended on this date
* @return this
*/
public CallReader setEndTime(final Range rangeEndTime) {
this.absoluteEndTime = null;
this.rangeEndTime = rangeEndTime;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Call ResourceSet
*/
@Override
public ResourceSet read(final TwilioRestClient client) {
return new ResourceSet<>(this, client, firstPage(client));
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Call ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page firstPage(final TwilioRestClient client) {
this.pathAccountSid = this.pathAccountSid == null ? client.getAccountSid() : this.pathAccountSid;
Request request = new Request(
HttpMethod.GET,
Domains.API.toString(),
"/2010-04-01/Accounts/" + this.pathAccountSid + "/Calls.json",
client.getRegion()
);
addQueryParams(request);
return pageForRequest(client, request);
}
/**
* Retrieve the target page from the Twilio API.
*
* @param targetUrl API-generated URL for the requested results page
* @param client TwilioRestClient with which to make the request
* @return Call ResourceSet
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public Page getPage(final String targetUrl, final TwilioRestClient client) {
this.pathAccountSid = this.pathAccountSid == null ? client.getAccountSid() : this.pathAccountSid;
Request request = new Request(
HttpMethod.GET,
targetUrl
);
return pageForRequest(client, request);
}
/**
* Retrieve the next page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Next Page
*/
@Override
public Page nextPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getNextPageUrl(
Domains.API.toString(),
client.getRegion()
)
);
return pageForRequest(client, request);
}
/**
* Retrieve the previous page from the Twilio API.
*
* @param page current page
* @param client TwilioRestClient with which to make the request
* @return Previous Page
*/
@Override
public Page previousPage(final Page page,
final TwilioRestClient client) {
Request request = new Request(
HttpMethod.GET,
page.getPreviousPageUrl(
Domains.API.toString(),
client.getRegion()
)
);
return pageForRequest(client, request);
}
/**
* Generate a Page of Call Resources for a given request.
*
* @param client TwilioRestClient with which to make the request
* @param request Request to generate a page for
* @return Page for the Request
*/
private Page pageForRequest(final TwilioRestClient client, final Request request) {
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("Call read 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 Page.fromJson(
"calls",
response.getContent(),
Call.class,
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 (to != null) {
request.addQueryParam("To", to.toString());
}
if (from != null) {
request.addQueryParam("From", from.toString());
}
if (parentCallSid != null) {
request.addQueryParam("ParentCallSid", parentCallSid);
}
if (status != null) {
request.addQueryParam("Status", status.toString());
}
if (absoluteStartTime != null) {
request.addQueryParam("StartTime", absoluteStartTime.toString(Request.QUERY_STRING_DATE_TIME_FORMAT));
} else if (rangeStartTime != null) {
request.addQueryDateTimeRange("StartTime", rangeStartTime);
}
if (absoluteEndTime != null) {
request.addQueryParam("EndTime", absoluteEndTime.toString(Request.QUERY_STRING_DATE_TIME_FORMAT));
} else if (rangeEndTime != null) {
request.addQueryDateTimeRange("EndTime", rangeEndTime);
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}