org.openapitools.client.api

Class EmailDomainApi

java.lang.Object

org.openapitools.client.api.EmailDomainApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-02-10T11:07:35.698-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.EmailDomainApi")
public class EmailDomainApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EmailDomainApi()
EmailDomainApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createEmailDomain(Class<?> T, EmailDomain emailDomain) Create an Email Domain Creates a custom email domain
EmailDomainResponse	createEmailDomain(EmailDomain emailDomain) Create an Email Domain Creates a custom email domain
PagedList	createEmailDomainWithPaginationInfo(EmailDomain emailDomain) Create an Email Domain Creates a custom email domain
void	deleteEmailDomain(String emailDomainId) Delete an Email Domain Deletes an Email Domain by `emailDomainId`
ApiClient	getApiClient()
EmailDomainResponse	getEmailDomain(String emailDomainId) Retrieve a Email Domain Retrieves an Email Domain by `emailDomainId`
PagedList	getEmailDomainWithPaginationInfo(String emailDomainId) Retrieve a Email Domain Retrieves an Email Domain by `emailDomainId`
List<Brand>	listEmailDomainBrands(String emailDomainId) List all brands linked to an email domain Lists all brands linked to an email domain
PagedList	listEmailDomainBrandsWithPaginationInfo(String emailDomainId) List all brands linked to an email domain Lists all brands linked to an email domain
EmailDomainListResponse	listEmailDomains() List all email domains Lists all the email domains in your org
PagedList	listEmailDomainsWithPaginationInfo() List all email domains Lists all the email domains in your org
<T> T	replaceEmailDomain(Class<?> T, String emailDomainId, UpdateEmailDomain updateEmailDomain) Replace an Email Domain Replaces an email domain by `emailDomainId`
EmailDomainResponse	replaceEmailDomain(String emailDomainId, UpdateEmailDomain updateEmailDomain) Replace an Email Domain Replaces an email domain by `emailDomainId`
PagedList	replaceEmailDomainWithPaginationInfo(String emailDomainId, UpdateEmailDomain updateEmailDomain) Replace an Email Domain Replaces an email domain by `emailDomainId`
void	setApiClient(ApiClient apiClient)
EmailDomainResponse	verifyEmailDomain(String emailDomainId) Verify an Email Domain Verifies an Email Domain by `emailDomainId`
PagedList	verifyEmailDomainWithPaginationInfo(String emailDomainId) Verify an Email Domain Verifies an Email Domain by `emailDomainId`

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailDomainApi

public EmailDomainApi()

EmailDomainApi

@Autowired
public EmailDomainApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createEmailDomain

public EmailDomainResponse createEmailDomain(EmailDomain emailDomain)
                                      throws org.springframework.web.client.RestClientException

Create an Email Domain Creates a custom email domain

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

emailDomain - (required)

Returns:

EmailDomainResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createEmailDomain

public <T> T createEmailDomain(Class<?> T,
                               EmailDomain emailDomain)
                        throws org.springframework.web.client.RestClientException

Create an Email Domain Creates a custom email domain

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

emailDomain - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createEmailDomainWithPaginationInfo

public PagedList createEmailDomainWithPaginationInfo(EmailDomain emailDomain)
                                              throws org.springframework.web.client.RestClientException

Create an Email Domain Creates a custom email domain

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

emailDomain - (required)

Returns:

ResponseEntity<EmailDomainResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteEmailDomain

public void deleteEmailDomain(String emailDomainId)
                       throws org.springframework.web.client.RestClientException

Delete an Email Domain Deletes an Email Domain by `emailDomainId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getEmailDomain

public EmailDomainResponse getEmailDomain(String emailDomainId)
                                   throws org.springframework.web.client.RestClientException

Retrieve a Email Domain Retrieves an Email Domain by `emailDomainId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

Returns:

EmailDomainResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getEmailDomainWithPaginationInfo

public PagedList getEmailDomainWithPaginationInfo(String emailDomainId)
                                           throws org.springframework.web.client.RestClientException

Retrieve a Email Domain Retrieves an Email Domain by `emailDomainId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

Returns:

ResponseEntity<EmailDomainResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listEmailDomainBrands

public List<Brand> listEmailDomainBrands(String emailDomainId)
                                  throws org.springframework.web.client.RestClientException

List all brands linked to an email domain Lists all brands linked to an email domain

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

Returns:

List<Brand>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listEmailDomainBrandsWithPaginationInfo

public PagedList listEmailDomainBrandsWithPaginationInfo(String emailDomainId)
                                                  throws org.springframework.web.client.RestClientException

List all brands linked to an email domain Lists all brands linked to an email domain

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

Returns:

ResponseEntity<List<Brand>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listEmailDomains

public EmailDomainListResponse listEmailDomains()
                                         throws org.springframework.web.client.RestClientException

List all email domains Lists all the email domains in your org

200 - OK

403 - Forbidden

429 - Too Many Requests

Returns:

EmailDomainListResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listEmailDomainsWithPaginationInfo

public PagedList listEmailDomainsWithPaginationInfo()
                                             throws org.springframework.web.client.RestClientException

List all email domains Lists all the email domains in your org

200 - OK

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<EmailDomainListResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceEmailDomain

public EmailDomainResponse replaceEmailDomain(String emailDomainId,
                                              UpdateEmailDomain updateEmailDomain)
                                       throws org.springframework.web.client.RestClientException

Replace an Email Domain Replaces an email domain by `emailDomainId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

updateEmailDomain - (required)

Returns:

EmailDomainResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceEmailDomain

public <T> T replaceEmailDomain(Class<?> T,
                                String emailDomainId,
                                UpdateEmailDomain updateEmailDomain)
                         throws org.springframework.web.client.RestClientException

Replace an Email Domain Replaces an email domain by `emailDomainId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

emailDomainId - (required)

updateEmailDomain - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceEmailDomainWithPaginationInfo

public PagedList replaceEmailDomainWithPaginationInfo(String emailDomainId,
                                                      UpdateEmailDomain updateEmailDomain)
                                               throws org.springframework.web.client.RestClientException

Replace an Email Domain Replaces an email domain by `emailDomainId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

updateEmailDomain - (required)

Returns:

ResponseEntity<EmailDomainResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

verifyEmailDomain

public EmailDomainResponse verifyEmailDomain(String emailDomainId)
                                      throws org.springframework.web.client.RestClientException

Verify an Email Domain Verifies an Email Domain by `emailDomainId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

Returns:

EmailDomainResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

verifyEmailDomainWithPaginationInfo

public PagedList verifyEmailDomainWithPaginationInfo(String emailDomainId)
                                              throws org.springframework.web.client.RestClientException

Verify an Email Domain Verifies an Email Domain by `emailDomainId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

emailDomainId - (required)

Returns:

ResponseEntity<EmailDomainResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API