java.lang.Object
- com.onfido.model.WebhookBuilder

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.9.0")
public class WebhookBuilder
extends Object

WebhookBuilder

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class WebhookBuilder.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ENABLED`
`static String`	`SERIALIZED_NAME_ENVIRONMENTS`
`static String`	`SERIALIZED_NAME_EVENTS`
`static String`	`SERIALIZED_NAME_PAYLOAD_VERSION`
`static String`	`SERIALIZED_NAME_URL`

Constructor Summary

Constructors
Constructor Description

WebhookBuilder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`WebhookBuilder`	`addEnvironmentsItem(String environmentsItem)`
`WebhookBuilder`	`addEventsItem(WebhookEventType eventsItem)`
`WebhookBuilder`	`enabled(Boolean enabled)`
`WebhookBuilder`	`environments(List<String> environments)`
`boolean`	`equals(Object o)`
`WebhookBuilder`	`events(List<WebhookEventType> events)`
`static WebhookBuilder`	`fromJson(String jsonString)`	Create an instance of WebhookBuilder given an JSON string
`Map<String,Object>`	`getAdditionalProperties()`	Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)`	Return the additional (undeclared) property with the specified name.
`Boolean`	`getEnabled()`	Determine if the webhook is active.
`List<String>`	`getEnvironments()`	The environments from which the webhook will receive events.
`List<WebhookEventType>`	`getEvents()`	The events that will be published to the webhook.
`Integer`	`getPayloadVersion()`	Webhook version used to control the payload object when sending webhooks.
`String`	`getUrl()`	The url that will listen to notifications (must be https).
`int`	`hashCode()`
`WebhookBuilder`	`payloadVersion(Integer payloadVersion)`
`WebhookBuilder`	`putAdditionalProperty(String key, Object value)`	Set the additional (undeclared) property with the specified name and value.
`void`	`setEnabled(Boolean enabled)`
`void`	`setEnvironments(List<String> environments)`
`void`	`setEvents(List<WebhookEventType> events)`
`void`	`setPayloadVersion(Integer payloadVersion)`
`void`	`setUrl(String url)`
`String`	`toJson()`	Convert an instance of WebhookBuilder to an JSON string
`String`	`toString()`
`WebhookBuilder`	`url(String url)`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)`	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_ENABLED
```
public static final String SERIALIZED_NAME_ENABLED
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EVENTS
```
public static final String SERIALIZED_NAME_EVENTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ENVIRONMENTS
```
public static final String SERIALIZED_NAME_ENVIRONMENTS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PAYLOAD_VERSION
```
public static final String SERIALIZED_NAME_PAYLOAD_VERSION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_URL
```
public static final String SERIALIZED_NAME_URL
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - WebhookBuilder
```
public WebhookBuilder()
```
- Method Detail
  - enabled
```
public WebhookBuilder enabled(Boolean enabled)
```
  - getEnabled
```
@Nullable
public Boolean getEnabled()
```
    Determine if the webhook is active.
    
    Returns:
    
    enabled
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
  - events
```
public WebhookBuilder events(List<WebhookEventType> events)
```
  - addEventsItem
```
public WebhookBuilder addEventsItem(WebhookEventType eventsItem)
```
  - getEvents
```
@Nullable
public List<WebhookEventType> getEvents()
```
    The events that will be published to the webhook. If the events parameter is omitted all the events will be subscribed.
    
    Returns:
    
    events
  - setEvents
```
public void setEvents(List<WebhookEventType> events)
```
  - environments
```
public WebhookBuilder environments(List<String> environments)
```
  - addEnvironmentsItem
```
public WebhookBuilder addEnvironmentsItem(String environmentsItem)
```
  - getEnvironments
```
@Nullable
public List<String> getEnvironments()
```
    The environments from which the webhook will receive events. Allowed values are “sandbox” and “live”. If the environments parameter is omitted the webhook will receive events from both environments.
    
    Returns:
    
    environments
  - setEnvironments
```
public void setEnvironments(List<String> environments)
```
  - payloadVersion
```
public WebhookBuilder payloadVersion(Integer payloadVersion)
```
  - getPayloadVersion
```
@Nullable
public Integer getPayloadVersion()
```
    Webhook version used to control the payload object when sending webhooks.
    
    Returns:
    
    payloadVersion
  - setPayloadVersion
```
public void setPayloadVersion(Integer payloadVersion)
```
  - url
```
public WebhookBuilder url(String url)
```
  - getUrl
```
@Nonnull
public String getUrl()
```
    The url that will listen to notifications (must be https).
    
    Returns:
    
    url
  - setUrl
```
public void setUrl(String url)
```
  - putAdditionalProperty
```
public WebhookBuilder putAdditionalProperty(String key,
                                            Object value)
```
    Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
    
    Parameters:
    
    key - name of the property
    
    value - value of the property
    
    Returns:
    
    the WebhookBuilder instance itself
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
    Return the additional (undeclared) property.
    
    Returns:
    
    a map of objects
  - getAdditionalProperty
```
public Object getAdditionalProperty(String key)
```
    Return the additional (undeclared) property with the specified name.
    
    Parameters:
    
    key - name of the property
    
    Returns:
    
    an object
  - 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
  - validateJsonElement
```
public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException
```
    Validates the JSON Element and throws an exception if issues found
    
    Parameters:
    
    jsonElement - JSON Element
    
    Throws:
    
    IOException - if the JSON Element is invalid with respect to WebhookBuilder
  - fromJson
```
public static WebhookBuilder fromJson(String jsonString)
                               throws IOException
```
    Create an instance of WebhookBuilder given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of WebhookBuilder
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to WebhookBuilder
  - toJson
```
public String toJson()
```
    Convert an instance of WebhookBuilder to an JSON string
    
    Returns:
    
    JSON string

Class WebhookBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_ENABLED

SERIALIZED_NAME_EVENTS

SERIALIZED_NAME_ENVIRONMENTS

SERIALIZED_NAME_PAYLOAD_VERSION

SERIALIZED_NAME_URL

openapiFields

openapiRequiredFields

Constructor Detail

WebhookBuilder

Method Detail

enabled

getEnabled

setEnabled

events

addEventsItem

getEvents

setEvents

environments

addEnvironmentsItem

getEnvironments

setEnvironments

payloadVersion

getPayloadVersion

setPayloadVersion

url

getUrl

setUrl

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson