org.openapitools.client.api

Class DomainApi

java.lang.Object

org.openapitools.client.api.DomainApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-10-28T09:54:00.189-05:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.DomainApi")
public class DomainApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DomainApi()
DomainApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createDomain(java.lang.Class<?> T, Domain domain) Create a Domain Creates your domain
DomainResponse	createDomain(Domain domain) Create a Domain Creates your domain
PagedList	createDomainWithPaginationInfo(Domain domain) Create a Domain Creates your domain
void	deleteDomain(java.lang.String domainId) Delete a Domain Deletes a Domain by `id`
ApiClient	getApiClient()
DomainResponse	getDomain(java.lang.String domainId) Retrieve a Domain Retrieves a Domain by `id`
PagedList	getDomainWithPaginationInfo(java.lang.String domainId) Retrieve a Domain Retrieves a Domain by `id`
DomainListResponse	listDomains() List all Domains Lists all verified custom Domains for the org
PagedList	listDomainsWithPaginationInfo() List all Domains Lists all verified custom Domains for the org
<T> T	replaceDomain(java.lang.Class<?> T, java.lang.String domainId, UpdateDomain updateDomain) Replace a Domain's brandId Replaces a Domain by `id`
DomainResponse	replaceDomain(java.lang.String domainId, UpdateDomain updateDomain) Replace a Domain's brandId Replaces a Domain by `id`
PagedList	replaceDomainWithPaginationInfo(java.lang.String domainId, UpdateDomain updateDomain) Replace a Domain's brandId Replaces a Domain by `id`
void	setApiClient(ApiClient apiClient)
void	upsertCertificate(java.lang.Class<?> T, java.lang.String domainId, DomainCertificate certificate) Upsert the Certificate Creates or replaces the certificate for the domain
void	upsertCertificate(java.lang.String domainId, DomainCertificate certificate) Upsert the Certificate Creates or replaces the certificate for the domain
DomainResponse	verifyDomain(java.lang.String domainId) Verify a Domain Verifies the Domain by `id`
PagedList	verifyDomainWithPaginationInfo(java.lang.String domainId) Verify a Domain Verifies the Domain by `id`

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainApi

public DomainApi()

DomainApi

@Autowired
public DomainApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createDomain

public DomainResponse createDomain(Domain domain)
                            throws org.springframework.web.client.RestClientException

Create a Domain Creates your domain

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

domain - (required)

Returns:

DomainResponse

Throws:

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

createDomain

public <T> T createDomain(java.lang.Class<?> T,
                          Domain domain)
                   throws org.springframework.web.client.RestClientException

Create a Domain Creates your domain

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

domain - (required)

Returns:

T instance

Throws:

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

createDomainWithPaginationInfo

public PagedList createDomainWithPaginationInfo(Domain domain)
                                         throws org.springframework.web.client.RestClientException

Create a Domain Creates your domain

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

domain - (required)

Returns:

ResponseEntity<DomainResponse>

Throws:

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

deleteDomain

public void deleteDomain(java.lang.String domainId)
                  throws org.springframework.web.client.RestClientException

Delete a Domain Deletes a Domain by `id`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

Throws:

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

getDomain

public DomainResponse getDomain(java.lang.String domainId)
                         throws org.springframework.web.client.RestClientException

Retrieve a Domain Retrieves a Domain by `id`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

Returns:

DomainResponse

Throws:

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

getDomainWithPaginationInfo

public PagedList getDomainWithPaginationInfo(java.lang.String domainId)
                                      throws org.springframework.web.client.RestClientException

Retrieve a Domain Retrieves a Domain by `id`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

Returns:

ResponseEntity<DomainResponse>

Throws:

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

listDomains

public DomainListResponse listDomains()
                               throws org.springframework.web.client.RestClientException

List all Domains Lists all verified custom Domains for the org

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

DomainListResponse

Throws:

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

listDomainsWithPaginationInfo

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

List all Domains Lists all verified custom Domains for the org

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<DomainListResponse>

Throws:

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

replaceDomain

public DomainResponse replaceDomain(java.lang.String domainId,
                                    UpdateDomain updateDomain)
                             throws org.springframework.web.client.RestClientException

Replace a Domain's brandId Replaces a Domain by `id`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

updateDomain - (required)

Returns:

DomainResponse

Throws:

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

replaceDomain

public <T> T replaceDomain(java.lang.Class<?> T,
                           java.lang.String domainId,
                           UpdateDomain updateDomain)
                    throws org.springframework.web.client.RestClientException

Replace a Domain's brandId Replaces a Domain by `id`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

domainId - (required)

updateDomain - (required)

Returns:

T instance

Throws:

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

replaceDomainWithPaginationInfo

public PagedList replaceDomainWithPaginationInfo(java.lang.String domainId,
                                                 UpdateDomain updateDomain)
                                          throws org.springframework.web.client.RestClientException

Replace a Domain's brandId Replaces a Domain by `id`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

updateDomain - (required)

Returns:

ResponseEntity<DomainResponse>

Throws:

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

upsertCertificate

public void upsertCertificate(java.lang.String domainId,
                              DomainCertificate certificate)
                       throws org.springframework.web.client.RestClientException

Upsert the Certificate Creates or replaces the certificate for the domain

204 - No Content

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

certificate - (required)

Throws:

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

upsertCertificate

public void upsertCertificate(java.lang.Class<?> T,
                              java.lang.String domainId,
                              DomainCertificate certificate)
                       throws org.springframework.web.client.RestClientException

Upsert the Certificate Creates or replaces the certificate for the domain

204 - No Content

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

domainId - (required)

certificate - (required)

Throws:

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

verifyDomain

public DomainResponse verifyDomain(java.lang.String domainId)
                            throws org.springframework.web.client.RestClientException

Verify a Domain Verifies the Domain by `id`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

Returns:

DomainResponse

Throws:

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

verifyDomainWithPaginationInfo

public PagedList verifyDomainWithPaginationInfo(java.lang.String domainId)
                                         throws org.springframework.web.client.RestClientException

Verify a Domain Verifies the Domain by `id`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

domainId - (required)

Returns:

ResponseEntity<DomainResponse>

Throws:

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