com.opsmatters.bitly.api.services.v4

Class WebhookService

java.lang.Object

com.opsmatters.bitly.api.services.BitlyService

com.opsmatters.bitly.api.services.v4.BitlyV4Service

com.opsmatters.bitly.api.services.v4.WebhookService

public class WebhookService
extends BitlyV4Service

The set of operations used for bitly webhooks.

Author:

Gerald Curley (opsmatters)

Field Summary

Fields inherited from class com.opsmatters.bitly.api.services.v4.BitlyV4Service

CREATE_BITLINK, CREATE_CAMPAIGN, CREATE_CHANNEL, CREATE_CUSTOM_BITLINK, CREATE_WEBHOOK, EXPAND_BITLINK, GET_BITLINK, GET_BITLINK_CLICKS, GET_BITLINK_CLICKS_SUMMARY, GET_BITLINK_QR_CODE, GET_BITLINKS_BY_GROUP, GET_CAMPAIGN, GET_CHANNEL, GET_CUSTOM_BITLINK, GET_GROUP, GET_GROUP_PREFERENCES, GET_GROUP_TAGS, GET_METRICS_BY_COUNTRIES, GET_METRICS_BY_DESTINATION, GET_METRICS_BY_REFERRERS, GET_METRICS_BY_REFERRERS_BY_DOMAIN, GET_METRICS_BY_REFERRING_DOMAINS, GET_METRICS_BY_REFERRING_NETWORKS, GET_OAUTH_APP, GET_ORGANIZATION, GET_SHORTEN_COUNTS, GET_SORTED_BITLINKS_BY_GROUP, GET_USER, GET_WEBHOOK, LIST_BSDS, LIST_CAMPAIGNS, LIST_CHANNELS, LIST_GROUPS, LIST_ORGANIZATIONS, LIST_WEBHOOKS, UPDATE_BITLINK, UPDATE_CAMPAIGN, UPDATE_CHANNEL, UPDATE_CUSTOM_BITLINK, UPDATE_GROUP, UPDATE_GROUP_PREFERENCES, UPDATE_USER, UPDATE_WEBHOOK

Fields inherited from class com.opsmatters.bitly.api.services.BitlyService

HTTP

Constructor Summary

Constructors

Constructor and Description
WebhookService(String accessToken, HttpContext httpContext) Constructor that takes a http context and API client.

Method Summary

Modifier and Type	Method and Description
com.google.common.base.Optional<CreateWebhookResponse>	create(CreateWebhookRequest request) Creates a webhook.
void	delete(String webhookGuid) Deletes the given webhook.
com.google.common.base.Optional<GetWebhookResponse>	get(String webhookGuid) Returns the attributes of the given webhook.
com.google.common.base.Optional<ListWebhooksResponse>	list(String organizationGuid) Returns the webooks for the given organization GUID.
com.google.common.base.Optional<UpdateWebhookResponse>	update(String webhookGuid, UpdateWebhookRequest request) Updates the attributes of the given webhook.

Methods inherited from class com.opsmatters.bitly.api.services.v4.BitlyV4Service

getQueryParameterList, getQueryParameterList

Methods inherited from class com.opsmatters.bitly.api.services.BitlyService

encode, getHeaders

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebhookService

public WebhookService(String accessToken,
                      HttpContext httpContext)

Constructor that takes a http context and API client.

Parameters:

accessToken - The access token used to authenticate the operations

httpContext - The set of HTTP operations

Method Detail

get

public com.google.common.base.Optional<GetWebhookResponse> get(String webhookGuid)
                                                        throws IOException,
                                                               URISyntaxException

Returns the attributes of the given webhook.

Parameters:

webhookGuid - The GUID of the webhook to be retrieved

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

create

public com.google.common.base.Optional<CreateWebhookResponse> create(CreateWebhookRequest request)
                                                              throws IOException

Creates a webhook.

Parameters:

request - The request containing the attributes of the webhook to be created

Returns:

The response object

Throws:

IOException - if there is a communication error.

update

public com.google.common.base.Optional<UpdateWebhookResponse> update(String webhookGuid,
                                                                     UpdateWebhookRequest request)
                                                              throws IOException,
                                                                     URISyntaxException

Updates the attributes of the given webhook.

Parameters:

webhookGuid - The GUID of the webhook to be updated

request - The request containing the attributes of the webhook to be updated

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

list

public com.google.common.base.Optional<ListWebhooksResponse> list(String organizationGuid)
                                                           throws IOException,
                                                                  URISyntaxException

Returns the webooks for the given organization GUID.

Parameters:

organizationGuid - The GUID of the organization for the webhooks to be retrieved

Returns:

The response object

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.

delete

public void delete(String webhookGuid)
            throws IOException,
                   URISyntaxException

Deletes the given webhook.

Parameters:

webhookGuid - The GUID of the webhook to be deleted

Throws:

IOException - if there is a communication error.

URISyntaxException - if there is a format error in the URL.