com.twilio.rest.sync.v1.service.DocumentDeleter 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.sync.v1.service;
import com.twilio.base.Deleter;
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 beta products that are subject to
* change. Use them with caution.
*/
public class DocumentDeleter extends Deleter {
private final String pathServiceSid;
private final String pathSid;
private String ifMatch;
/**
* Construct a new DocumentDeleter.
*
* @param pathServiceSid The SID of the Sync Service with the Document resource
* to delete
* @param pathSid The SID of the Document resource to delete
*/
public DocumentDeleter(final String pathServiceSid,
final String pathSid) {
this.pathServiceSid = pathServiceSid;
this.pathSid = pathSid;
}
/**
* The If-Match HTTP request header.
*
* @param ifMatch The If-Match HTTP request header
* @return this
*/
public DocumentDeleter setIfMatch(final String ifMatch) {
this.ifMatch = ifMatch;
return this;
}
/**
* Make the request to the Twilio API to perform the delete.
*
* @param client TwilioRestClient with which to make the request
*/
@Override
@SuppressWarnings("checkstyle:linelength")
public boolean delete(final TwilioRestClient client) {
Request request = new Request(
HttpMethod.DELETE,
Domains.SYNC.toString(),
"/v1/Services/" + this.pathServiceSid + "/Documents/" + this.pathSid + ""
);
addHeaderParams(request);
Response response = client.request(request);
if (response == null) {
throw new ApiConnectionException("Document delete 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 response.getStatusCode() == 204;
}
/**
* Add the requested header parameters to the Request.
*
* @param request Request to add header params to
*/
private void addHeaderParams(final Request request) {
if (ifMatch != null) {
request.addHeaderParam("If-Match", ifMatch);
}
}
}