Package com.dnsimple.endpoints

Class Services

java.lang.Object

com.dnsimple.endpoints.Services

public class Services
extends Object

Provides access to the DNSimple one-click Services API.

See Also:

• https://developer.dnsimple.com/v2/services

Constructor Summary

Constructors

Constructor	Description
Services(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
PaginatedResponse<Service>	appliedServices(Number account, String domain)	Lists the one-click services applied to the domain.
PaginatedResponse<Service>	appliedServices(Number account, String domain, ListOptions options)	Lists the one-click services applied to the domain.
SimpleResponse<Service>	applyService(Number account, String domain, String service, Map<String,Object> settings)	Apply the given one-click service to the given domain.
SimpleResponse<Service>	getService(String service)	Get a specific service by ID.
ListResponse<Service>	listServices()	Lists the available one-click services.
ListResponse<Service>	listServices(ListOptions options)	Lists the available one-click services.
SimpleResponse<Service>	unapplyService(Number account, String domain, String service)	Unapply the given one-click service the given domain.

Methods inherited from class java.lang.Object

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

Constructor Details

Services

public Services(HttpEndpointClient client)

Method Details

listServices

public ListResponse<Service> listServices()

Lists the available one-click services.

Returns:

The list services response

See Also:

• https://developer.dnsimple.com/v2/services/#list

listServices

public ListResponse<Service> listServices(ListOptions options)

Lists the available one-click services.

Parameters:

options - The options for the list request

Returns:

The list services response

See Also:

• https://developer.dnsimple.com/v2/services/#listServices

getService

public SimpleResponse<Service> getService(String service)

Get a specific service by ID.

Parameters:

service - The service name or ID

Returns:

The get service response

See Also:

• https://developer.dnsimple.com/v2/services/#getService

appliedServices

public PaginatedResponse<Service> appliedServices(Number account,
 String domain)

Lists the one-click services applied to the domain.

Parameters:

account - The account ID

domain - The domain name or ID

Returns:

The applied services response

See Also:

• https://developer.dnsimple.com/v2/services/domains/#listDomainAppliedServices

appliedServices

public PaginatedResponse<Service> appliedServices(Number account,
 String domain,
 ListOptions options)

Lists the one-click services applied to the domain.

Parameters:

account - The account ID

domain - The domain name or ID

options - The options for the list request

Returns:

The applied services response

See Also:

• https://developer.dnsimple.com/v2/services/domains/#listDomainAppliedServices

applyService

public SimpleResponse<Service> applyService(Number account,
 String domain,
 String service,
 Map<String,Object> settings)

Apply the given one-click service to the given domain.

Parameters:

account - The account ID

domain - The domain name or ID

service - The service name or ID to apply

settings - A Map of settings for the service

Returns:

The apply service response

See Also:

• https://developer.dnsimple.com/v2/services/domains/#applyServiceToDomain

unapplyService

public SimpleResponse<Service> unapplyService(Number account,
 String domain,
 String service)

Unapply the given one-click service the given domain.

Parameters:

account - The account ID

domain - The domain name or ID

service - The service name or ID to unapply

Returns:

The unapply service response

See Also:

• https://developer.dnsimple.com/v2/services/domains/#unapplyServiceFromDomain