com.sendgrid

Interface SendGridAPI

All Known Implementing Classes:

BaseInterface, SendGrid, TwilioEmail

public interface SendGridAPI

Method Summary

Modifier and Type	Method and Description
Map<String,String>	addRequestHeader(String key, String value) Add/update a request header.
com.sendgrid.Response	api(com.sendgrid.Request request) Class api sets up the request to the Twilio SendGrid API, this is main interface.
String	getHost() Get the host.
String	getLibraryVersion() Get the current library version.
Map<String,String>	getRequestHeaders() Get the request headers.
String	getVersion() Get the API version.
void	initialize(String auth, String host) Initialize the client.
com.sendgrid.Response	makeCall(com.sendgrid.Request request) Makes the call to the Twilio SendGrid API, override this method for testing.
Map<String,String>	removeRequestHeader(String key) Remove a request header.
void	setHost(String host) Set the host.
void	setVersion(String version) Set the API version.

Method Detail

initialize

void initialize(String auth,
                String host)

Initialize the client.

Parameters:

auth - authorization header value

host - the base URL for the API

getLibraryVersion

String getLibraryVersion()

Get the current library version.

Returns:

the current version

getVersion

String getVersion()

Get the API version.

Returns:

the current API version

setVersion

void setVersion(String version)

Set the API version.

Parameters:

version - the new version

getRequestHeaders

Map<String,String> getRequestHeaders()

Get the request headers.

Returns:

the request headers

addRequestHeader

Map<String,String> addRequestHeader(String key,
                                    String value)

Add/update a request header.

Parameters:

key - the header key

value - the header value

Returns:

the new set of request headers

removeRequestHeader

Map<String,String> removeRequestHeader(String key)

Remove a request header.

Parameters:

key - the header key to remove

Returns:

the new set of request headers

getHost

String getHost()

Get the host.

Returns:

the host

setHost

void setHost(String host)

Set the host.

Parameters:

host - the new host

makeCall

com.sendgrid.Response makeCall(com.sendgrid.Request request)
                        throws IOException

Makes the call to the Twilio SendGrid API, override this method for testing.

Parameters:

request - the request to make

Returns:

the response object

Throws:

IOException - in case of a network error

api

com.sendgrid.Response api(com.sendgrid.Request request)
                   throws IOException

Class api sets up the request to the Twilio SendGrid API, this is main interface.

Parameters:

request - the request object

Returns:

the response object

Throws:

IOException - in case of a network error