net.nextpulse.postmarkapp.api.server

Class TagTriggersAPIApi

java.lang.Object

net.nextpulse.postmarkapp.api.server.TagTriggersAPIApi

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

Constructor Summary

Constructors

Constructor and Description
TagTriggersAPIApi()
TagTriggersAPIApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
InlineResponse2008Tags	createTagTrigger(String xPostmarkServerToken, EditTagTriggerRequest body) Create a trigger for a tag
StandardPostmarkResponse	deleteTagTrigger(String xPostmarkServerToken, Integer triggerid) Delete a single trigger
InlineResponse2008Tags	editTagTrigger(String xPostmarkServerToken, Integer triggerid, EditTagTriggerRequest body) Edit a single trigger
ApiClient	getApiClient()
InlineResponse2008Tags	getSingleTagTrigger(String xPostmarkServerToken, Integer triggerid) Get a single trigger
InlineResponse2008	searcgTagTriggers(String xPostmarkServerToken, Integer count, Integer offset, String matchName) Search triggers
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

TagTriggersAPIApi

public TagTriggersAPIApi()

TagTriggersAPIApi

public TagTriggersAPIApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createTagTrigger

public InlineResponse2008Tags createTagTrigger(String xPostmarkServerToken,
                                               EditTagTriggerRequest body)
                                        throws ApiException

Create a trigger for a tag

Parameters:

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

body - (optional)

Returns:

InlineResponse2008Tags

Throws:

ApiException - if fails to make API call

deleteTagTrigger

public StandardPostmarkResponse deleteTagTrigger(String xPostmarkServerToken,
                                                 Integer triggerid)
                                          throws ApiException

Delete a single trigger

Parameters:

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

triggerid - The ID for the Tag Trigger that should be deleted. (required)

Returns:

StandardPostmarkResponse

Throws:

ApiException - if fails to make API call

editTagTrigger

public InlineResponse2008Tags editTagTrigger(String xPostmarkServerToken,
                                             Integer triggerid,
                                             EditTagTriggerRequest body)
                                      throws ApiException

Edit a single trigger

Parameters:

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

triggerid - The ID of the Tag Trigger that should be modified by this request. (required)

body - (optional)

Returns:

InlineResponse2008Tags

Throws:

ApiException - if fails to make API call

getSingleTagTrigger

public InlineResponse2008Tags getSingleTagTrigger(String xPostmarkServerToken,
                                                  Integer triggerid)
                                           throws ApiException

Get a single trigger

Parameters:

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

triggerid - The ID for the Tag Trigger for which data should be retrieved. (required)

Returns:

InlineResponse2008Tags

Throws:

ApiException - if fails to make API call

searcgTagTriggers

public InlineResponse2008 searcgTagTriggers(String xPostmarkServerToken,
                                            Integer count,
                                            Integer offset,
                                            String matchName)
                                     throws ApiException

Search triggers

Parameters:

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

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

offset - Number of records to skip. (required)

matchName - Filter by delivery tag (optional)

Returns:

InlineResponse2008

Throws:

ApiException - if fails to make API call