org.openapitools.client.api

Class EmailDomainApi

java.lang.Object

org.openapitools.client.api.EmailDomainApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class EmailDomainApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EmailDomainApi()
EmailDomainApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EmailDomainResponse	createEmailDomain(EmailDomain emailDomain, List<String> expand) Create an Email Domain Creates an Email Domain in your org
EmailDomainResponse	createEmailDomain(EmailDomain emailDomain, List<String> expand, Map<String,String> additionalHeaders) Create an Email Domain Creates an Email Domain in your org
void	deleteEmailDomain(String emailDomainId, List<String> expand) Delete an Email Domain Deletes an Email Domain by `emailDomainId`
void	deleteEmailDomain(String emailDomainId, List<String> expand, Map<String,String> additionalHeaders) Delete an Email Domain Deletes an Email Domain by `emailDomainId`
ApiClient	getApiClient()
EmailDomainResponseWithEmbedded	getEmailDomain(String emailDomainId, List<String> expand) Retrieve an Email Domain Retrieves an Email Domain by `emailDomainId`
EmailDomainResponseWithEmbedded	getEmailDomain(String emailDomainId, List<String> expand, Map<String,String> additionalHeaders) Retrieve an Email Domain Retrieves an Email Domain by `emailDomainId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<EmailDomainResponseWithEmbedded>	listEmailDomains(List<String> expand) List all Email Domains Lists all the Email Domains in your org
List<EmailDomainResponseWithEmbedded>	listEmailDomains(List<String> expand, Map<String,String> additionalHeaders) List all Email Domains Lists all the Email Domains in your org
EmailDomainResponse	replaceEmailDomain(String emailDomainId, UpdateEmailDomain updateEmailDomain, List<String> expand) Replace an Email Domain Replaces associated username and sender display name by `emailDomainId`
EmailDomainResponse	replaceEmailDomain(String emailDomainId, UpdateEmailDomain updateEmailDomain, List<String> expand, Map<String,String> additionalHeaders) Replace an Email Domain Replaces associated username and sender display name by `emailDomainId`
void	setApiClient(ApiClient apiClient)
EmailDomainResponse	verifyEmailDomain(String emailDomainId) Verify an Email Domain Verifies an Email Domain by `emailDomainId`
EmailDomainResponse	verifyEmailDomain(String emailDomainId, Map<String,String> additionalHeaders) 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

public EmailDomainApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createEmailDomain

public EmailDomainResponse createEmailDomain(EmailDomain emailDomain,
                                             List<String> expand)
                                      throws ApiException

Create an Email Domain Creates an Email Domain in your org

Parameters:

emailDomain - (required)

expand - Specifies additional metadata to be included in the response (optional

Returns:

EmailDomainResponse

Throws:

ApiException - if fails to make API call

createEmailDomain

public EmailDomainResponse createEmailDomain(EmailDomain emailDomain,
                                             List<String> expand,
                                             Map<String,String> additionalHeaders)
                                      throws ApiException

Create an Email Domain Creates an Email Domain in your org

Parameters:

emailDomain - (required)

expand - Specifies additional metadata to be included in the response (optional

additionalHeaders - additionalHeaders for this call

Returns:

EmailDomainResponse

Throws:

ApiException - if fails to make API call

deleteEmailDomain

public void deleteEmailDomain(String emailDomainId,
                              List<String> expand)
                       throws ApiException

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

Parameters:

emailDomainId - (required)

expand - Specifies additional metadata to be included in the response (optional

Throws:

ApiException - if fails to make API call

deleteEmailDomain

public void deleteEmailDomain(String emailDomainId,
                              List<String> expand,
                              Map<String,String> additionalHeaders)
                       throws ApiException

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

Parameters:

emailDomainId - (required)

expand - Specifies additional metadata to be included in the response (optional

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getEmailDomain

public EmailDomainResponseWithEmbedded getEmailDomain(String emailDomainId,
                                                      List<String> expand)
                                               throws ApiException

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

Parameters:

emailDomainId - (required)

expand - Specifies additional metadata to be included in the response (optional

Returns:

EmailDomainResponseWithEmbedded

Throws:

ApiException - if fails to make API call

getEmailDomain

public EmailDomainResponseWithEmbedded getEmailDomain(String emailDomainId,
                                                      List<String> expand,
                                                      Map<String,String> additionalHeaders)
                                               throws ApiException

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

Parameters:

emailDomainId - (required)

expand - Specifies additional metadata to be included in the response (optional

additionalHeaders - additionalHeaders for this call

Returns:

EmailDomainResponseWithEmbedded

Throws:

ApiException - if fails to make API call

listEmailDomains

public List<EmailDomainResponseWithEmbedded> listEmailDomains(List<String> expand)
                                                       throws ApiException

List all Email Domains Lists all the Email Domains in your org

Parameters:

expand - Specifies additional metadata to be included in the response (optional

Returns:

List<EmailDomainResponseWithEmbedded>

Throws:

ApiException - if fails to make API call

listEmailDomains

public List<EmailDomainResponseWithEmbedded> listEmailDomains(List<String> expand,
                                                              Map<String,String> additionalHeaders)
                                                       throws ApiException

List all Email Domains Lists all the Email Domains in your org

Parameters:

expand - Specifies additional metadata to be included in the response (optional

additionalHeaders - additionalHeaders for this call

Returns:

List<EmailDomainResponseWithEmbedded>

Throws:

ApiException - if fails to make API call

replaceEmailDomain

public EmailDomainResponse replaceEmailDomain(String emailDomainId,
                                              UpdateEmailDomain updateEmailDomain,
                                              List<String> expand)
                                       throws ApiException

Replace an Email Domain Replaces associated username and sender display name by `emailDomainId`

Parameters:

emailDomainId - (required)

updateEmailDomain - (required)

expand - Specifies additional metadata to be included in the response (optional

Returns:

EmailDomainResponse

Throws:

ApiException - if fails to make API call

replaceEmailDomain

public EmailDomainResponse replaceEmailDomain(String emailDomainId,
                                              UpdateEmailDomain updateEmailDomain,
                                              List<String> expand,
                                              Map<String,String> additionalHeaders)
                                       throws ApiException

Replace an Email Domain Replaces associated username and sender display name by `emailDomainId`

Parameters:

emailDomainId - (required)

updateEmailDomain - (required)

expand - Specifies additional metadata to be included in the response (optional

additionalHeaders - additionalHeaders for this call

Returns:

EmailDomainResponse

Throws:

ApiException - if fails to make API call

verifyEmailDomain

public EmailDomainResponse verifyEmailDomain(String emailDomainId)
                                      throws ApiException

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

Parameters:

emailDomainId - (required)

Returns:

EmailDomainResponse

Throws:

ApiException - if fails to make API call

verifyEmailDomain

public EmailDomainResponse verifyEmailDomain(String emailDomainId,
                                             Map<String,String> additionalHeaders)
                                      throws ApiException

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

Parameters:

emailDomainId - (required)

additionalHeaders - additionalHeaders for this call

Returns:

EmailDomainResponse

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()