WebhookNewContactPayload (mailslurp-client-java 15.17.17 API)

java.lang.Object
- com.mailslurp.models.WebhookNewContactPayload

```
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-12T23:33:57.654989Z[Etc/UTC]")
public class WebhookNewContactPayload
extends Object
```
NEW_CONTACT webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is received by the inbox that your webhook is attached to that contains a recipient that has not been saved as a contact.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WebhookNewContactPayload.CustomTypeAdapterFactory`
`static class`	`WebhookNewContactPayload.EventNameEnum` Name of the event type webhook is being triggered for.

Field Summary

Fields
Modifier and Type	Field and Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_COMPANY`
`static String`	`SERIALIZED_NAME_CONTACT_ID`
`static String`	`SERIALIZED_NAME_CREATED_AT`
`static String`	`SERIALIZED_NAME_EMAIL_ADDRESSES`
`static String`	`SERIALIZED_NAME_EVENT_NAME`
`static String`	`SERIALIZED_NAME_FIRST_NAME`
`static String`	`SERIALIZED_NAME_GROUP_ID`
`static String`	`SERIALIZED_NAME_LAST_NAME`
`static String`	`SERIALIZED_NAME_MESSAGE_ID`
`static String`	`SERIALIZED_NAME_META_DATA`
`static String`	`SERIALIZED_NAME_OPT_OUT`
`static String`	`SERIALIZED_NAME_PRIMARY_EMAIL_ADDRESS`
`static String`	`SERIALIZED_NAME_TAGS`
`static String`	`SERIALIZED_NAME_WEBHOOK_ID`
`static String`	`SERIALIZED_NAME_WEBHOOK_NAME`

Constructor Summary

Constructors
Constructor and Description

WebhookNewContactPayload()

Constructors
Constructor and Description
`WebhookNewContactPayload()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WebhookNewContactPayload`	`addEmailAddressesItem(String emailAddressesItem)`
`WebhookNewContactPayload`	`addTagsItem(String tagsItem)`
`WebhookNewContactPayload`	`company(String company)`
`WebhookNewContactPayload`	`contactId(UUID contactId)`
`WebhookNewContactPayload`	`createdAt(OffsetDateTime createdAt)`
`WebhookNewContactPayload`	`emailAddresses(List<String> emailAddresses)`
`boolean`	`equals(Object o)`
`WebhookNewContactPayload`	`eventName(WebhookNewContactPayload.EventNameEnum eventName)`
`WebhookNewContactPayload`	`firstName(String firstName)`
`static WebhookNewContactPayload`	`fromJson(String jsonString)` Create an instance of WebhookNewContactPayload given an JSON string
`String`	`getCompany()` Contact company name
`UUID`	`getContactId()` Contact ID
`OffsetDateTime`	`getCreatedAt()` Date time of event creation
`List<String>`	`getEmailAddresses()` Email addresses for contact
`WebhookNewContactPayload.EventNameEnum`	`getEventName()` Name of the event type webhook is being triggered for.
`String`	`getFirstName()` Contact first name
`UUID`	`getGroupId()` Contact group ID
`String`	`getLastName()` Contact last name
`String`	`getMessageId()` Idempotent message ID.
`Object`	`getMetaData()` Get metaData
`Boolean`	`getOptOut()` Has contact opted out of emails
`String`	`getPrimaryEmailAddress()` Primary email address for contact
`List<String>`	`getTags()` Tags for contact
`UUID`	`getWebhookId()` ID of webhook entity being triggered
`String`	`getWebhookName()` Name of the webhook being triggered
`WebhookNewContactPayload`	`groupId(UUID groupId)`
`int`	`hashCode()`
`WebhookNewContactPayload`	`lastName(String lastName)`
`WebhookNewContactPayload`	`messageId(String messageId)`
`WebhookNewContactPayload`	`metaData(Object metaData)`
`WebhookNewContactPayload`	`optOut(Boolean optOut)`
`WebhookNewContactPayload`	`primaryEmailAddress(String primaryEmailAddress)`
`void`	`setCompany(String company)`
`void`	`setContactId(UUID contactId)`
`void`	`setCreatedAt(OffsetDateTime createdAt)`
`void`	`setEmailAddresses(List<String> emailAddresses)`
`void`	`setEventName(WebhookNewContactPayload.EventNameEnum eventName)`
`void`	`setFirstName(String firstName)`
`void`	`setGroupId(UUID groupId)`
`void`	`setLastName(String lastName)`
`void`	`setMessageId(String messageId)`
`void`	`setMetaData(Object metaData)`
`void`	`setOptOut(Boolean optOut)`
`void`	`setPrimaryEmailAddress(String primaryEmailAddress)`
`void`	`setTags(List<String> tags)`
`void`	`setWebhookId(UUID webhookId)`
`void`	`setWebhookName(String webhookName)`
`WebhookNewContactPayload`	`tags(List<String> tags)`
`String`	`toJson()` Convert an instance of WebhookNewContactPayload to an JSON string
`String`	`toString()`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)` Validates the JSON Object and throws an exception if issues found
`WebhookNewContactPayload`	`webhookId(UUID webhookId)`
`WebhookNewContactPayload`	`webhookName(String webhookName)`

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

Field Detail

SERIALIZED_NAME_MESSAGE_ID

public static final String SERIALIZED_NAME_MESSAGE_ID

See Also:: Constant Field Values

SERIALIZED_NAME_WEBHOOK_ID

public static final String SERIALIZED_NAME_WEBHOOK_ID

See Also:: Constant Field Values

SERIALIZED_NAME_WEBHOOK_NAME

public static final String SERIALIZED_NAME_WEBHOOK_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_EVENT_NAME

public static final String SERIALIZED_NAME_EVENT_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_CONTACT_ID

public static final String SERIALIZED_NAME_CONTACT_ID

See Also:: Constant Field Values

SERIALIZED_NAME_GROUP_ID

public static final String SERIALIZED_NAME_GROUP_ID

See Also:: Constant Field Values

SERIALIZED_NAME_FIRST_NAME

public static final String SERIALIZED_NAME_FIRST_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_LAST_NAME

public static final String SERIALIZED_NAME_LAST_NAME

See Also:: Constant Field Values

SERIALIZED_NAME_COMPANY

public static final String SERIALIZED_NAME_COMPANY

See Also:: Constant Field Values

SERIALIZED_NAME_PRIMARY_EMAIL_ADDRESS

public static final String SERIALIZED_NAME_PRIMARY_EMAIL_ADDRESS

See Also:: Constant Field Values

SERIALIZED_NAME_EMAIL_ADDRESSES

public static final String SERIALIZED_NAME_EMAIL_ADDRESSES

See Also:: Constant Field Values

SERIALIZED_NAME_TAGS

public static final String SERIALIZED_NAME_TAGS

See Also:: Constant Field Values

SERIALIZED_NAME_META_DATA

public static final String SERIALIZED_NAME_META_DATA

See Also:: Constant Field Values

SERIALIZED_NAME_OPT_OUT

public static final String SERIALIZED_NAME_OPT_OUT

See Also:: Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:: Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Detail
- WebhookNewContactPayload
```
public WebhookNewContactPayload()
```

Method Detail

messageId

public WebhookNewContactPayload messageId(String messageId)

getMessageId
```
@Nonnull
public String getMessageId()
```
Idempotent message ID. Store this ID locally or in a database to prevent message duplication.

Returns:

messageId

setMessageId

public void setMessageId(String messageId)

webhookId

public WebhookNewContactPayload webhookId(UUID webhookId)

getWebhookId
```
@Nonnull
public UUID getWebhookId()
```
ID of webhook entity being triggered

Returns:

webhookId

setWebhookId

public void setWebhookId(UUID webhookId)

webhookName

public WebhookNewContactPayload webhookName(String webhookName)

getWebhookName
```
@Nullable
public String getWebhookName()
```
Name of the webhook being triggered

Returns:

webhookName

setWebhookName

public void setWebhookName(String webhookName)

eventName

public WebhookNewContactPayload eventName(WebhookNewContactPayload.EventNameEnum eventName)

getEventName
```
@Nonnull
public WebhookNewContactPayload.EventNameEnum getEventName()
```
Name of the event type webhook is being triggered for.

Returns:

eventName

setEventName

public void setEventName(WebhookNewContactPayload.EventNameEnum eventName)

contactId

public WebhookNewContactPayload contactId(UUID contactId)

getContactId
```
@Nonnull
public UUID getContactId()
```
Contact ID

Returns:

contactId

setContactId

public void setContactId(UUID contactId)

groupId

public WebhookNewContactPayload groupId(UUID groupId)

getGroupId
```
@Nullable
public UUID getGroupId()
```
Contact group ID

Returns:

groupId

setGroupId
```
public void setGroupId(UUID groupId)
```

firstName

public WebhookNewContactPayload firstName(String firstName)

getFirstName
```
@Nullable
public String getFirstName()
```
Contact first name

Returns:

firstName

setFirstName

public void setFirstName(String firstName)

lastName

public WebhookNewContactPayload lastName(String lastName)

getLastName
```
@Nullable
public String getLastName()
```
Contact last name

Returns:

lastName

setLastName

public void setLastName(String lastName)

company

public WebhookNewContactPayload company(String company)

getCompany
```
@Nullable
public String getCompany()
```
Contact company name

Returns:

company

setCompany

public void setCompany(String company)

primaryEmailAddress

public WebhookNewContactPayload primaryEmailAddress(String primaryEmailAddress)

getPrimaryEmailAddress
```
@Nullable
public String getPrimaryEmailAddress()
```
Primary email address for contact

Returns:

primaryEmailAddress

setPrimaryEmailAddress

public void setPrimaryEmailAddress(String primaryEmailAddress)

emailAddresses

public WebhookNewContactPayload emailAddresses(List<String> emailAddresses)

addEmailAddressesItem

public WebhookNewContactPayload addEmailAddressesItem(String emailAddressesItem)

getEmailAddresses
```
@Nonnull
public List<String> getEmailAddresses()
```
Email addresses for contact

Returns:

emailAddresses

setEmailAddresses

public void setEmailAddresses(List<String> emailAddresses)

addTagsItem

public WebhookNewContactPayload addTagsItem(String tagsItem)

getTags

@Nonnull
public List<String> getTags()

Tags for contact

Returns:: tags

setTags

public void setTags(List<String> tags)

metaData

public WebhookNewContactPayload metaData(Object metaData)

getMetaData
```
@Nullable
public Object getMetaData()
```
Get metaData

Returns:

metaData

setMetaData

public void setMetaData(Object metaData)

optOut

public WebhookNewContactPayload optOut(Boolean optOut)

getOptOut
```
@Nonnull
public Boolean getOptOut()
```
Has contact opted out of emails

Returns:

optOut

setOptOut

public void setOptOut(Boolean optOut)

createdAt

public WebhookNewContactPayload createdAt(OffsetDateTime createdAt)

getCreatedAt
```
@Nonnull
public OffsetDateTime getCreatedAt()
```
Date time of event creation

Returns:

createdAt

setCreatedAt

public void setCreatedAt(OffsetDateTime createdAt)

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

validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
Validates the JSON Object and throws an exception if issues found

Parameters:

jsonObj - JSON Object

Throws:

IOException - if the JSON Object is invalid with respect to WebhookNewContactPayload

fromJson
```
public static WebhookNewContactPayload fromJson(String jsonString)
                                         throws IOException
```
Create an instance of WebhookNewContactPayload given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of WebhookNewContactPayload

Throws:

IOException - if the JSON string is invalid with respect to WebhookNewContactPayload

toJson
```
public String toJson()
```
Convert an instance of WebhookNewContactPayload to an JSON string

Returns:

JSON string

Class WebhookNewContactPayload

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_MESSAGE_ID

SERIALIZED_NAME_WEBHOOK_ID

SERIALIZED_NAME_WEBHOOK_NAME

SERIALIZED_NAME_EVENT_NAME

SERIALIZED_NAME_CONTACT_ID

SERIALIZED_NAME_GROUP_ID

SERIALIZED_NAME_FIRST_NAME

SERIALIZED_NAME_LAST_NAME

SERIALIZED_NAME_COMPANY

SERIALIZED_NAME_PRIMARY_EMAIL_ADDRESS

SERIALIZED_NAME_EMAIL_ADDRESSES

SERIALIZED_NAME_TAGS

SERIALIZED_NAME_META_DATA

SERIALIZED_NAME_OPT_OUT

SERIALIZED_NAME_CREATED_AT

openapiFields

openapiRequiredFields

Constructor Detail

WebhookNewContactPayload

Method Detail

messageId

getMessageId

setMessageId

webhookId

getWebhookId

setWebhookId

webhookName

getWebhookName

setWebhookName

eventName

getEventName

setEventName

contactId

getContactId

setContactId

groupId

getGroupId

setGroupId

firstName

getFirstName

setFirstName

lastName

getLastName

setLastName

company

getCompany

setCompany

primaryEmailAddress

getPrimaryEmailAddress

setPrimaryEmailAddress

emailAddresses

addEmailAddressesItem

getEmailAddresses

setEmailAddresses

tags

addTagsItem

getTags

setTags

metaData

getMetaData

setMetaData

optOut

getOptOut

setOptOut

createdAt

getCreatedAt

setCreatedAt

equals

hashCode

toString

validateJsonObject

fromJson

toJson