Package com.mypurecloud.sdk.v2.model

Class ContactEnrichRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.ContactEnrichRequest

All Implemented Interfaces:

Serializable

public class ContactEnrichRequest
extends Object
implements Serializable

ContactEnrichRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ContactEnrichRequest.ActionEnum	The action that should be taken based on any Contacts found by `matchingIdentifiers`.

Constructor Summary

Constructors

Constructor	Description
ContactEnrichRequest()
ContactEnrichRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ContactEnrichRequest	action(ContactEnrichRequest.ActionEnum action)	The action that should be taken based on any Contacts found by `matchingIdentifiers`.
ContactEnrichRequest	contact(ExternalContact contact)	Data to be added, either as an update to an existing Contact or the body of a new Contact.
ContactEnrichRequest	division(WritableStarrableDivision division)	The division to which this entity belongs.
boolean	equals(Object o)
ContactEnrichRequest	fieldRules(EnrichFieldRules fieldRules)	Logic describing how to combine data from the submitted request with data found in the database.
ContactEnrichRequest.ActionEnum	getAction()
ExternalContact	getContact()
WritableStarrableDivision	getDivision()
EnrichFieldRules	getFieldRules()
String	getId()
List<ContactIdentifier>	getMatchingIdentifiers()
ContactEnrichOptions	getOptions()
int	hashCode()
ContactEnrichRequest	id(String id)	A user-specified tracker string, only useful in the Bulk-Enrich API.
ContactEnrichRequest	matchingIdentifiers(List<ContactIdentifier> matchingIdentifiers)	An ordered list of one or more Identifiers which might each be claimed by a Contact.
ContactEnrichRequest	options(ContactEnrichOptions options)	Additional options modifying the behavior of the API operation.
void	setAction(ContactEnrichRequest.ActionEnum action)
void	setContact(ExternalContact contact)
void	setDivision(WritableStarrableDivision division)
void	setFieldRules(EnrichFieldRules fieldRules)
void	setId(String id)
void	setMatchingIdentifiers(List<ContactIdentifier> matchingIdentifiers)
void	setOptions(ContactEnrichOptions options)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ContactEnrichRequest

public ContactEnrichRequest()

ContactEnrichRequest

public ContactEnrichRequest(Boolean initWithEmptyList)

Method Details

id

public ContactEnrichRequest id(String id)

A user-specified tracker string, only useful in the Bulk-Enrich API. If one Bulk-Enrich operation in a request fails, the requested operation will be repeated in the Bulk API response, including this id field, allowing associating of request and response operations.

getId

public String getId()

setId

public void setId(String id)

division

public ContactEnrichRequest division(WritableStarrableDivision division)

The division to which this entity belongs.

getDivision

public WritableStarrableDivision getDivision()

setDivision

public void setDivision(WritableStarrableDivision division)

matchingIdentifiers

public ContactEnrichRequest matchingIdentifiers(List<ContactIdentifier> matchingIdentifiers)

An ordered list of one or more Identifiers which might each be claimed by a Contact. `action` describes what to do with any possibly matching Contacts. Identifier lookups will occur in the order specified here. Between 1 and 25.

getMatchingIdentifiers

public List<ContactIdentifier> getMatchingIdentifiers()

setMatchingIdentifiers

public void setMatchingIdentifiers(List<ContactIdentifier> matchingIdentifiers)

action

public ContactEnrichRequest action(ContactEnrichRequest.ActionEnum action)

The action that should be taken based on any Contacts found by `matchingIdentifiers`.

getAction

public ContactEnrichRequest.ActionEnum getAction()

setAction

public void setAction(ContactEnrichRequest.ActionEnum action)

contact

public ContactEnrichRequest contact(ExternalContact contact)

Data to be added, either as an update to an existing Contact or the body of a new Contact. Omitting a field in this contract means that it will be treated as null in the `fieldRules` logic.

getContact

public ExternalContact getContact()

setContact

public void setContact(ExternalContact contact)

fieldRules

public ContactEnrichRequest fieldRules(EnrichFieldRules fieldRules)

Logic describing how to combine data from the submitted request with data found in the database.

getFieldRules

public EnrichFieldRules getFieldRules()

setFieldRules

public void setFieldRules(EnrichFieldRules fieldRules)

options

public ContactEnrichRequest options(ContactEnrichOptions options)

Additional options modifying the behavior of the API operation.

getOptions

public ContactEnrichOptions getOptions()

setOptions

public void setOptions(ContactEnrichOptions options)

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