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

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

Webhook

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Webhook.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_HREF`
`static String`	`SERIALIZED_NAME_ID`
`static String`	`SERIALIZED_NAME_PAYLOAD_VERSION`
`static String`	`SERIALIZED_NAME_TOKEN`
`static String`	`SERIALIZED_NAME_URL`

Constructor Summary

Constructors
Constructor Description

Webhook()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Webhook`	`addEnvironmentsItem(String environmentsItem)`
`Webhook`	`addEventsItem(WebhookEventType eventsItem)`
`Webhook`	`enabled(Boolean enabled)`
`Webhook`	`environments(List<String> environments)`
`boolean`	`equals(Object o)`
`Webhook`	`events(List<WebhookEventType> events)`
`static Webhook`	`fromJson(String jsonString)`	Create an instance of Webhook 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.
`String`	`getHref()`	The API endpoint to retrieve the webhook.
`UUID`	`getId()`	The unique identifier of the webhook.
`Integer`	`getPayloadVersion()`	Webhook version used to control the payload object when sending webhooks.
`String`	`getToken()`	Webhook secret token used to sign the webhook's payload.
`String`	`getUrl()`	The url that will listen to notifications (must be https).
`int`	`hashCode()`
`Webhook`	`href(String href)`
`Webhook`	`id(UUID id)`
`Webhook`	`payloadVersion(Integer payloadVersion)`
`Webhook`	`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`	`setHref(String href)`
`void`	`setId(UUID id)`
`void`	`setPayloadVersion(Integer payloadVersion)`
`void`	`setToken(String token)`
`void`	`setUrl(String url)`
`String`	`toJson()`	Convert an instance of Webhook to an JSON string
`Webhook`	`token(String token)`
`String`	`toString()`
`Webhook`	`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_ID
```
public static final String SERIALIZED_NAME_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_URL
```
public static final String SERIALIZED_NAME_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TOKEN
```
public static final String SERIALIZED_NAME_TOKEN
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_HREF
```
public static final String SERIALIZED_NAME_HREF
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - Webhook
```
public Webhook()
```
- Method Detail
  - enabled
```
public Webhook enabled(Boolean enabled)
```
  - getEnabled
```
@Nullable
public Boolean getEnabled()
```
    Determine if the webhook is active.
    
    Returns:
    
    enabled
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
  - events
```
public Webhook events(List<WebhookEventType> events)
```
  - addEventsItem
```
public Webhook 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 Webhook environments(List<String> environments)
```
  - addEnvironmentsItem
```
public Webhook 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 Webhook 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)
```
  - id
```
public Webhook id(UUID id)
```
  - getId
```
@Nonnull
public UUID getId()
```
    The unique identifier of the webhook.
    
    Returns:
    
    id
  - setId
```
public void setId(UUID id)
```
  - url
```
public Webhook url(String url)
```
  - getUrl
```
@Nullable
public String getUrl()
```
    The url that will listen to notifications (must be https).
    
    Returns:
    
    url
  - setUrl
```
public void setUrl(String url)
```
  - token
```
public Webhook token(String token)
```
  - getToken
```
@Nullable
public String getToken()
```
    Webhook secret token used to sign the webhook's payload.
    
    Returns:
    
    token
  - setToken
```
public void setToken(String token)
```
  - href
```
public Webhook href(String href)
```
  - getHref
```
@Nullable
public String getHref()
```
    The API endpoint to retrieve the webhook.
    
    Returns:
    
    href
  - setHref
```
public void setHref(String href)
```
  - putAdditionalProperty
```
public Webhook 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 Webhook 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 Webhook
  - fromJson
```
public static Webhook fromJson(String jsonString)
                        throws IOException
```
    Create an instance of Webhook given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of Webhook
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to Webhook
  - toJson
```
public String toJson()
```
    Convert an instance of Webhook to an JSON string
    
    Returns:
    
    JSON string

Class Webhook

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_ID

SERIALIZED_NAME_URL

SERIALIZED_NAME_TOKEN

SERIALIZED_NAME_HREF

openapiFields

openapiRequiredFields

Constructor Detail

Webhook

Method Detail

enabled

getEnabled

setEnabled

events

addEventsItem

getEvents

setEvents

environments

addEnvironmentsItem

getEnvironments

setEnvironments

payloadVersion

getPayloadVersion

setPayloadVersion

id

getId

setId

url

getUrl

setUrl

token

getToken

setToken

href

getHref

setHref

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson