com.twilio.rest.api.v2010.account.usage.record.YearlyReader 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.usage.record;
import com.twilio.base.Page;
import com.twilio.base.Reader;
import com.twilio.base.ResourceSet;
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 java.time.LocalDate;
public class YearlyReader extends Reader {
private String pathAccountSid;
private Yearly.Category category;
private LocalDate startDate;
private LocalDate endDate;
private Boolean includeSubaccounts;
/**
* Construct a new YearlyReader.
*/
public YearlyReader() {
}
/**
* Construct a new YearlyReader.
*
* @param pathAccountSid The SID of the Account that created the resources to
* read
*/
public YearlyReader(final String pathAccountSid) {
this.pathAccountSid = pathAccountSid;
}
/**
* The usage
* category of the UsageRecord resources to read. Only UsageRecord resources
* in the specified category are retrieved..
*
* @param category The usage category of the UsageRecord resources to read
* @return this
*/
public YearlyReader setCategory(final Yearly.Category category) {
this.category = category;
return this;
}
/**
* Only include usage that has occurred on or after this date. Specify the date
* in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the
* current date, such as: `-30days`, which will set the start date to be 30 days
* before the current date..
*
* @param startDate Only include usage that has occurred on or after this date
* @return this
*/
public YearlyReader setStartDate(final LocalDate startDate) {
this.startDate = startDate;
return this;
}
/**
* Only include usage that occurred on or before this date. Specify the date in
* GMT and format as `YYYY-MM-DD`. You can also specify offsets from the
* current date, such as: `+30days`, which will set the end date to 30 days from
* the current date..
*
* @param endDate Only include usage that occurred on or before this date
* @return this
*/
public YearlyReader setEndDate(final LocalDate endDate) {
this.endDate = endDate;
return this;
}
/**
* Whether to include usage from the master account and all its subaccounts. Can
* be: `true` (the default) to include usage from the master account and all
* subaccounts or `false` to retrieve usage from only the specified account..
*
* @param includeSubaccounts Whether to include usage from the master account
* and all its subaccounts
* @return this
*/
public YearlyReader setIncludeSubaccounts(final Boolean includeSubaccounts) {
this.includeSubaccounts = includeSubaccounts;
return this;
}
/**
* Make the request to the Twilio API to perform the read.
*
* @param client TwilioRestClient with which to make the request
* @return Yearly 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 Yearly 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 + "/Usage/Records/Yearly.json"
);
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 Yearly 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())
);
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())
);
return pageForRequest(client, request);
}
/**
* Generate a Page of Yearly 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("Yearly read 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 Page.fromJson(
"usage_records",
response.getContent(),
Yearly.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 (category != null) {
request.addQueryParam("Category", category.toString());
}
if (startDate != null) {
request.addQueryParam("StartDate", DateConverter.dateStringFromLocalDate(startDate));
}
if (endDate != null) {
request.addQueryParam("EndDate", DateConverter.dateStringFromLocalDate(endDate));
}
if (includeSubaccounts != null) {
request.addQueryParam("IncludeSubaccounts", includeSubaccounts.toString());
}
if (getPageSize() != null) {
request.addQueryParam("PageSize", Integer.toString(getPageSize()));
}
}
}