Package com.courier.api.resources.automations

Class AutomationsClient

java.lang.Object

com.courier.api.resources.automations.AutomationsClient

public class AutomationsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AutomationsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
AutomationInvokeResponse	invokeAdHocAutomation(AutomationAdHocInvokeParams request)	Invoke an ad hoc automation run.
AutomationInvokeResponse	invokeAdHocAutomation(AutomationAdHocInvokeParams request, IdempotentRequestOptions requestOptions)	Invoke an ad hoc automation run.
AutomationInvokeResponse	invokeAutomationTemplate(java.lang.String templateId)	Invoke an automation run from an automation template.
AutomationInvokeResponse	invokeAutomationTemplate(java.lang.String templateId, AutomationInvokeParams request)	Invoke an automation run from an automation template.
AutomationInvokeResponse	invokeAutomationTemplate(java.lang.String templateId, AutomationInvokeParams request, IdempotentRequestOptions requestOptions)	Invoke an automation run from an automation template.

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

AutomationsClient

public AutomationsClient(ClientOptions clientOptions)

Method Detail

invokeAutomationTemplate

public AutomationInvokeResponse invokeAutomationTemplate(java.lang.String templateId)

Invoke an automation run from an automation template.

invokeAutomationTemplate

public AutomationInvokeResponse invokeAutomationTemplate(java.lang.String templateId,
                                                         AutomationInvokeParams request)

Invoke an automation run from an automation template.

invokeAutomationTemplate

public AutomationInvokeResponse invokeAutomationTemplate(java.lang.String templateId,
                                                         AutomationInvokeParams request,
                                                         IdempotentRequestOptions requestOptions)

Invoke an automation run from an automation template.

invokeAdHocAutomation

public AutomationInvokeResponse invokeAdHocAutomation(AutomationAdHocInvokeParams request)

Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide here.

invokeAdHocAutomation

public AutomationInvokeResponse invokeAdHocAutomation(AutomationAdHocInvokeParams request,
                                                      IdempotentRequestOptions requestOptions)

Invoke an ad hoc automation run. This endpoint accepts a JSON payload with a series of automation steps. For information about what steps are available, checkout the ad hoc automation guide here.