net.nextpulse.postmarkapp.api.account

Class DomainsAPIApi

java.lang.Object

net.nextpulse.postmarkapp.api.account.DomainsAPIApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T16:43:30.269+01:00")
public class DomainsAPIApi
extends Object

Constructor Summary

Constructors

Constructor and Description
DomainsAPIApi()
DomainsAPIApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DomainExtendedInformation	createDomain(String xPostmarkAccountToken, DomainCreationModel body) Create a Domain
StandardPostmarkResponse	deleteDomain(String xPostmarkAccountToken, Integer domainid) Delete a Domain
DomainExtendedInformation	editDomain(String xPostmarkAccountToken, Integer domainid, DomainEditingModel body) Update a Domain
ApiClient	getApiClient()
DomainExtendedInformation	getDomain(String xPostmarkAccountToken, Integer domainid) Get a Domain
DomainListingResults	listDomains(String xPostmarkAccountToken, Integer count, Integer offset) List Domains
DomainSPFResult	requestSPFVerificationForDomain(String xPostmarkAccountToken, Integer domainid) Request DNS Verification for SPF
DKIMRotationResponse	rotateDKIMKeyForDomain(String xPostmarkAccountToken, Integer domainid) Rotate DKIM Key Creates a new DKIM key to replace your current key.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

DomainsAPIApi

public DomainsAPIApi()

DomainsAPIApi

public DomainsAPIApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createDomain

public DomainExtendedInformation createDomain(String xPostmarkAccountToken,
                                              DomainCreationModel body)
                                       throws ApiException

Create a Domain

Parameters:

xPostmarkAccountToken - The token associated with the Account on which this request will operate. (required)

body - (optional)

Returns:

DomainExtendedInformation

Throws:

ApiException - if fails to make API call

deleteDomain

public StandardPostmarkResponse deleteDomain(String xPostmarkAccountToken,
                                             Integer domainid)
                                      throws ApiException

Delete a Domain

Parameters:

xPostmarkAccountToken - The token associated with the Account on which this request will operate. (required)

domainid - The ID for the Domain that should be deleted by the request. (required)

Returns:

StandardPostmarkResponse

Throws:

ApiException - if fails to make API call

editDomain

public DomainExtendedInformation editDomain(String xPostmarkAccountToken,
                                            Integer domainid,
                                            DomainEditingModel body)
                                     throws ApiException

Update a Domain

Parameters:

xPostmarkAccountToken - The token associated with the Account on which this request will operate. (required)

domainid - The ID for the Domain that should be modified by the request. (required)

body - (optional)

Returns:

DomainExtendedInformation

Throws:

ApiException - if fails to make API call

getDomain

public DomainExtendedInformation getDomain(String xPostmarkAccountToken,
                                           Integer domainid)
                                    throws ApiException

Get a Domain

Parameters:

xPostmarkAccountToken - The token associated with the Account on which this request will operate. (required)

domainid - The ID for the Domain that should be retrieved. (required)

Returns:

DomainExtendedInformation

Throws:

ApiException - if fails to make API call

listDomains

public DomainListingResults listDomains(String xPostmarkAccountToken,
                                        Integer count,
                                        Integer offset)
                                 throws ApiException

List Domains

Parameters:

xPostmarkAccountToken - The token associated with the Account on which this request will operate. (required)

count - Number of records to return per request. Max 500. (required)

offset - Number of records to skip (required)

Returns:

DomainListingResults

Throws:

ApiException - if fails to make API call

requestSPFVerificationForDomain

public DomainSPFResult requestSPFVerificationForDomain(String xPostmarkAccountToken,
                                                       Integer domainid)
                                                throws ApiException

Request DNS Verification for SPF

Parameters:

xPostmarkAccountToken - The token associated with the Account on which this request will operate. (required)

domainid - The ID for the Domain for which SPF DNS records should be verified. (required)

Returns:

DomainSPFResult

Throws:

ApiException - if fails to make API call

rotateDKIMKeyForDomain

public DKIMRotationResponse rotateDKIMKeyForDomain(String xPostmarkAccountToken,
                                                   Integer domainid)
                                            throws ApiException

Rotate DKIM Key Creates a new DKIM key to replace your current key. Until the DNS entries are confirmed, the new values will be in the `DKIMPendingHost` and `DKIMPendingTextValue` fields. After the new DKIM value is verified in DNS, the pending values will migrate to `DKIMTextValue` and `DKIMPendingTextValue` and Postmark will begin to sign emails with the new DKIM key.

Parameters:

xPostmarkAccountToken - The token associated with the Account on which this request will operate. (required)

domainid - The ID for the Sender Signature for which a new DKIM Key should be generated. (required)

Returns:

DKIMRotationResponse

Throws:

ApiException - if fails to make API call