net.nextpulse.postmarkapp.api.account

Class ServerManagementAPIApi

java.lang.Object

net.nextpulse.postmarkapp.api.account.ServerManagementAPIApi

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

Constructor Summary

Constructors

Constructor and Description
ServerManagementAPIApi()
ServerManagementAPIApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ExtendedServerInfo	createServer(String xPostmarkAccountToken, CreateServerPayload body) Create a Server
void	deleteServer(String xPostmarkAccountToken, Integer serverid) Delete a Server
ExtendedServerInfo	editServerInformation(String xPostmarkAccountToken, Integer serverid, EditServerPayload body) Edit a Server
ApiClient	getApiClient()
ExtendedServerInfo	getServerInformation(String xPostmarkAccountToken, Integer serverid) Get a Server
ServerListingResponse	listServers(String xPostmarkAccountToken, Integer count, Integer offset, String name) List servers
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerManagementAPIApi

public ServerManagementAPIApi()

ServerManagementAPIApi

public ServerManagementAPIApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createServer

public ExtendedServerInfo createServer(String xPostmarkAccountToken,
                                       CreateServerPayload body)
                                throws ApiException

Create a Server

Parameters:

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

body - (optional)

Returns:

ExtendedServerInfo

Throws:

ApiException - if fails to make API call

deleteServer

public void deleteServer(String xPostmarkAccountToken,
                         Integer serverid)
                  throws ApiException

Delete a Server

Parameters:

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

serverid - The ID of the Server that should be deleted. (required)

Throws:

ApiException - if fails to make API call

editServerInformation

public ExtendedServerInfo editServerInformation(String xPostmarkAccountToken,
                                                Integer serverid,
                                                EditServerPayload body)
                                         throws ApiException

Edit a Server

Parameters:

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

serverid - The ID of the Server to update. (required)

body - (optional)

Returns:

ExtendedServerInfo

Throws:

ApiException - if fails to make API call

getServerInformation

public ExtendedServerInfo getServerInformation(String xPostmarkAccountToken,
                                               Integer serverid)
                                        throws ApiException

Get a Server

Parameters:

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

serverid - The ID of the Server to get. (required)

Returns:

ExtendedServerInfo

Throws:

ApiException - if fails to make API call

listServers

public ServerListingResponse listServers(String xPostmarkAccountToken,
                                         Integer count,
                                         Integer offset,
                                         String name)
                                  throws ApiException

List servers

Parameters:

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

count - Number of servers to return per request. (required)

offset - Number of servers to skip. (required)

name - Filter by a specific server name (optional)

Returns:

ServerListingResponse

Throws:

ApiException - if fails to make API call