Package software.xdev.brevo.api

Class DomainsApi

java.lang.Object

software.xdev.brevo.client.BaseApi

software.xdev.brevo.api.DomainsApi

public class DomainsApi
extends BaseApi

Field Summary

Fields inherited from class software.xdev.brevo.client.BaseApi

apiClient

Constructor Summary

Constructors

Constructor	Description
DomainsApi()
DomainsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AuthenticateDomainModel	authenticateDomain(String domainName)	Authenticate a domain
AuthenticateDomainModel	authenticateDomain(String domainName, Map<String,String> additionalHeaders)	Authenticate a domain
CreateDomainModel	createDomain(CreateDomain domain)	Create a new domain
CreateDomainModel	createDomain(CreateDomain domain, Map<String,String> additionalHeaders)	Create a new domain
void	deleteDomain(String domainName)	Delete a domain
void	deleteDomain(String domainName, Map<String,String> additionalHeaders)	Delete a domain
GetDomainConfigurationModel	getDomainConfiguration(String domainName)	Validate domain configuration
GetDomainConfigurationModel	getDomainConfiguration(String domainName, Map<String,String> additionalHeaders)	Validate domain configuration
GetDomainsList	getDomains()	Get the list of all your domains
GetDomainsList	getDomains(Map<String,String> additionalHeaders)	Get the list of all your domains
<T> T	invokeAPI(String url, String method, Object request, com.fasterxml.jackson.core.type.TypeReference<T> returnType, Map<String,String> additionalHeaders)	Directly invoke the API for the given URL.

Methods inherited from class software.xdev.brevo.client.BaseApi

getApiClient, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, invokeAPI, setApiClient

Methods inherited from class java.lang.Object

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

Constructor Details

DomainsApi

public DomainsApi()

DomainsApi

public DomainsApi(ApiClient apiClient)

Method Details

authenticateDomain

public AuthenticateDomainModel authenticateDomain(@Nonnull
 String domainName)
                                           throws ApiException

Authenticate a domain

Parameters:

domainName - Domain name (required)

Returns:

AuthenticateDomainModel

Throws:

ApiException - if fails to make API call

authenticateDomain

public AuthenticateDomainModel authenticateDomain(@Nonnull
 String domainName,
 Map<String,String> additionalHeaders)
                                           throws ApiException

Authenticate a domain

Parameters:

domainName - Domain name (required)

additionalHeaders - additionalHeaders for this call

Returns:

AuthenticateDomainModel

Throws:

ApiException - if fails to make API call

createDomain

public CreateDomainModel createDomain(@Nullable
 CreateDomain domain)
                               throws ApiException

Create a new domain

Parameters:

domain - domain's name (optional)

Returns:

CreateDomainModel

Throws:

ApiException - if fails to make API call

createDomain

public CreateDomainModel createDomain(@Nullable
 CreateDomain domain,
 Map<String,String> additionalHeaders)
                               throws ApiException

Create a new domain

Parameters:

domain - domain's name (optional)

additionalHeaders - additionalHeaders for this call

Returns:

CreateDomainModel

Throws:

ApiException - if fails to make API call

deleteDomain

public void deleteDomain(@Nonnull
 String domainName)
                  throws ApiException

Delete a domain

Parameters:

domainName - Domain name (required)

Throws:

ApiException - if fails to make API call

deleteDomain

public void deleteDomain(@Nonnull
 String domainName,
 Map<String,String> additionalHeaders)
                  throws ApiException

Delete a domain

Parameters:

domainName - Domain name (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getDomainConfiguration

public GetDomainConfigurationModel getDomainConfiguration(@Nonnull
 String domainName)
                                                   throws ApiException

Validate domain configuration

Parameters:

domainName - Domain name (required)

Returns:

GetDomainConfigurationModel

Throws:

ApiException - if fails to make API call

getDomainConfiguration

public GetDomainConfigurationModel getDomainConfiguration(@Nonnull
 String domainName,
 Map<String,String> additionalHeaders)
                                                   throws ApiException

Validate domain configuration

Parameters:

domainName - Domain name (required)

additionalHeaders - additionalHeaders for this call

Returns:

GetDomainConfigurationModel

Throws:

ApiException - if fails to make API call

getDomains

public GetDomainsList getDomains()
                          throws ApiException

Get the list of all your domains

Returns:

GetDomainsList

Throws:

ApiException - if fails to make API call

getDomains

public GetDomainsList getDomains(Map<String,String> additionalHeaders)
                          throws ApiException

Get the list of all your domains

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

GetDomainsList

Throws:

ApiException - if fails to make API call

invokeAPI

public <T> T invokeAPI(String url,
 String method,
 Object request,
 com.fasterxml.jackson.core.type.TypeReference<T> returnType,
 Map<String,String> additionalHeaders)
                throws ApiException

Description copied from class: BaseApi

Directly invoke the API for the given URL. Useful if the API returns direct links/URLs for subsequent requests.

Specified by:

invokeAPI in class BaseApi

Parameters:

url - The URL for the request, either full URL or only the path.

method - The HTTP method for the request.

request - The request object.

returnType - The return type.

additionalHeaders - Additional headers for the request.

Returns:

The API response in the specified type.

Throws:

ApiException - if fails to make API call.