io.swagger.client.model

Class NotificationRuleParams

java.lang.Object

io.swagger.client.model.NotificationRuleParams

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-05-14T19:12:52.919Z")
public class NotificationRuleParams
extends Object

Parameters of notification rule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NotificationRuleParams.TriggerEventEnum Trigger event type

Constructor Summary

Constructors

Constructor and Description
NotificationRuleParams()

Method Summary

Modifier and Type	Method and Description
NotificationRuleParams	callbackHandle(String callbackHandle)
boolean	equals(Object o)
String	getCallbackHandle() An arbitrary string that finAPI will include into the notifications that it sends based on this rule and that you can use to identify the notification in your application.
Map<String,String>	getParams() Additional parameters that are specific to the chosen trigger event type.
NotificationRuleParams.TriggerEventEnum	getTriggerEvent() Trigger event type
int	hashCode()
NotificationRuleParams	includeDetails(Boolean includeDetails)
Boolean	isIncludeDetails() Whether the notification messages that will be sent based on this rule should contain encrypted detailed data or not
NotificationRuleParams	params(Map<String,String> params)
NotificationRuleParams	putParamsItem(String key, String paramsItem)
void	setCallbackHandle(String callbackHandle)
void	setIncludeDetails(Boolean includeDetails)
void	setParams(Map<String,String> params)
void	setTriggerEvent(NotificationRuleParams.TriggerEventEnum triggerEvent)
String	toString()
NotificationRuleParams	triggerEvent(NotificationRuleParams.TriggerEventEnum triggerEvent)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NotificationRuleParams

public NotificationRuleParams()

Method Detail

triggerEvent

public NotificationRuleParams triggerEvent(NotificationRuleParams.TriggerEventEnum triggerEvent)

getTriggerEvent

public NotificationRuleParams.TriggerEventEnum getTriggerEvent()

Trigger event type

Returns:

triggerEvent

setTriggerEvent

public void setTriggerEvent(NotificationRuleParams.TriggerEventEnum triggerEvent)

params

public NotificationRuleParams params(Map<String,String> params)

putParamsItem

public NotificationRuleParams putParamsItem(String key,
                                            String paramsItem)

getParams

public Map<String,String> getParams()

Additional parameters that are specific to the chosen trigger event type. Please refer to the documentation for details.

Returns:

params

setParams

public void setParams(Map<String,String> params)

callbackHandle

public NotificationRuleParams callbackHandle(String callbackHandle)

getCallbackHandle

public String getCallbackHandle()

An arbitrary string that finAPI will include into the notifications that it sends based on this rule and that you can use to identify the notification in your application. For instance, you could include the identifier of the user that you create this rule for. Maximum allowed length of the string is 512 characters.<br/><br/>Note that for this parameter, you can pass the symbols '/', '=', '%' and '\"' in addition to the symbols that are generally allowed in finAPI (see https://finapi.zendesk.com/hc/en-us/articles/222013148). This was done to enable you to set Base64 encoded strings and JSON structures for the callback handle.

Returns:

callbackHandle

setCallbackHandle

public void setCallbackHandle(String callbackHandle)

includeDetails

public NotificationRuleParams includeDetails(Boolean includeDetails)

isIncludeDetails

public Boolean isIncludeDetails()

Whether the notification messages that will be sent based on this rule should contain encrypted detailed data or not

Returns:

includeDetails

setIncludeDetails

public void setIncludeDetails(Boolean includeDetails)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object