com.opsmatters.bitly.api.services.v4

Class GroupService

java.lang.Object

com.opsmatters.bitly.api.services.BitlyService

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

com.opsmatters.bitly.api.services.v4.GroupService

public class GroupService
extends BitlyV4Service

The set of operations used for bitly groups.

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
GroupService(String accessToken, HttpContext httpContext) Constructor that takes a http context and API client.

Method Summary

Modifier and Type	Method and Description
void	delete(String groupGuid) Deletes the given group.
com.google.common.base.Optional<GetGroupResponse>	get(String groupGuid) Returns the attributes of the given group.
com.google.common.base.Optional<GetBitlinksByGroupResponse>	getBitlinks(String groupGuid, BitlinkQuery query) Returns the bitlinks for the given group.
com.google.common.base.Optional<GetMetricsByCountriesResponse>	getMetricsByCountries(String groupGuid, UnitQuery query) Returns the metrics for the given group by countries.
com.google.common.base.Optional<GetMetricsByReferringNetworksResponse>	getMetricsByReferringNetworks(String groupGuid) Returns the metrics for the given group by referring networks.
com.google.common.base.Optional<GetGroupPreferencesResponse>	getPreferences(String groupGuid) Returns the preferences for the given group.
com.google.common.base.Optional<GetShortenCountsResponse>	getShortenCounts(String groupGuid, UnitQuery query) Returns the shorten counts for the given group.
com.google.common.base.Optional<GetSortedBitlinksByGroupResponse>	getSortedBitlinks(String groupGuid, Sort sort, UnitQuery query) Returns the sorted bitlinks for the given group.
com.google.common.base.Optional<GetGroupTagsResponse>	getTags(String groupGuid) Returns the tags for the given group.
com.google.common.base.Optional<ListGroupsResponse>	list(String organizationGuid) Returns the groups for the given organization GUID.
com.google.common.base.Optional<UpdateGroupResponse>	update(String groupGuid, UpdateGroupRequest request) Updates the attributes of the given group.
com.google.common.base.Optional<UpdateGroupPreferencesResponse>	updatePreferences(String groupGuid, UpdateGroupPreferencesRequest request) Updates the preferences of the given group.

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

GroupService

public GroupService(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<GetGroupResponse> get(String groupGuid)
                                                      throws IOException,
                                                             URISyntaxException

Returns the attributes of the given group.

Parameters:

groupGuid - The GUID of the group 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.

update

public com.google.common.base.Optional<UpdateGroupResponse> update(String groupGuid,
                                                                   UpdateGroupRequest request)
                                                            throws IOException,
                                                                   URISyntaxException

Updates the attributes of the given group.

Parameters:

groupGuid - The GUID of the group to be updated

request - The request containing the attributes of the group 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<ListGroupsResponse> list(String organizationGuid)
                                                         throws IOException,
                                                                URISyntaxException

Returns the groups for the given organization GUID.

Parameters:

organizationGuid - The GUID of the organization for the groups 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 groupGuid)
            throws IOException,
                   URISyntaxException

Deletes the given group.

Parameters:

groupGuid - The GUID of the group to be deleted

Throws:

IOException - if there is a communication error.

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

getTags

public com.google.common.base.Optional<GetGroupTagsResponse> getTags(String groupGuid)
                                                              throws IOException,
                                                                     URISyntaxException

Returns the tags for the given group.

Parameters:

groupGuid - The GUID of the group with the tags

Returns:

The response object

Throws:

IOException - if there is a communication error.

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

getShortenCounts

public com.google.common.base.Optional<GetShortenCountsResponse> getShortenCounts(String groupGuid,
                                                                                  UnitQuery query)
                                                                           throws IOException,
                                                                                  URISyntaxException

Returns the shorten counts for the given group.

Parameters:

groupGuid - The guid for the group

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

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

getPreferences

public com.google.common.base.Optional<GetGroupPreferencesResponse> getPreferences(String groupGuid)
                                                                            throws IOException,
                                                                                   URISyntaxException

Returns the preferences for the given group.

Parameters:

groupGuid - The GUID of the group with the preferences

Returns:

The response object

Throws:

IOException - if there is a communication error.

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

updatePreferences

public com.google.common.base.Optional<UpdateGroupPreferencesResponse> updatePreferences(String groupGuid,
                                                                                         UpdateGroupPreferencesRequest request)
                                                                                  throws IOException,
                                                                                         URISyntaxException

Updates the preferences of the given group.

Parameters:

groupGuid - The GUID of the group to be updated

request - The request containing the preferences of the group 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.

getBitlinks

public com.google.common.base.Optional<GetBitlinksByGroupResponse> getBitlinks(String groupGuid,
                                                                               BitlinkQuery query)
                                                                        throws IOException,
                                                                               URISyntaxException

Returns the bitlinks for the given group.

Parameters:

groupGuid - The guid for the group

query - The attributes of the bitlinks to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

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

getSortedBitlinks

public com.google.common.base.Optional<GetSortedBitlinksByGroupResponse> getSortedBitlinks(String groupGuid,
                                                                                           Sort sort,
                                                                                           UnitQuery query)
                                                                                    throws IOException,
                                                                                           URISyntaxException

Returns the sorted bitlinks for the given group.

Parameters:

groupGuid - The guid for the group

sort - The sort for the group

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

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

getMetricsByCountries

public com.google.common.base.Optional<GetMetricsByCountriesResponse> getMetricsByCountries(String groupGuid,
                                                                                            UnitQuery query)
                                                                                     throws IOException,
                                                                                            URISyntaxException

Returns the metrics for the given group by countries.

Parameters:

groupGuid - The GUID of the group for the metrics

query - The attributes of the units to use for the query

Returns:

The response object

Throws:

IOException - if there is a communication error.

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

getMetricsByReferringNetworks

public com.google.common.base.Optional<GetMetricsByReferringNetworksResponse> getMetricsByReferringNetworks(String groupGuid)
                                                                                                     throws IOException,
                                                                                                            URISyntaxException

Returns the metrics for the given group by referring networks.

Parameters:

groupGuid - The GUID of the group for the metrics

Returns:

The response object

Throws:

IOException - if there is a communication error.

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