Package com.mypurecloud.sdk.v2.model

Class ExternalOrganizationEnrichRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.ExternalOrganizationEnrichRequest

All Implemented Interfaces:

Serializable

public class ExternalOrganizationEnrichRequest
extends Object
implements Serializable

ExternalOrganizationEnrichRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ExternalOrganizationEnrichRequest()
ExternalOrganizationEnrichRequest(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalOrganizationEnrichRequest

public ExternalOrganizationEnrichRequest()

ExternalOrganizationEnrichRequest

public ExternalOrganizationEnrichRequest(Boolean initWithEmptyList)

Method Details

id

public ExternalOrganizationEnrichRequest 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 request and response operations.

getId

public String getId()

setId

public void setId(String id)

division

public ExternalOrganizationEnrichRequest division(WritableStarrableDivision division)

The division to which this entity belongs.

getDivision

public WritableStarrableDivision getDivision()

setDivision

public void setDivision(WritableStarrableDivision division)

matchingIdentifiers

public ExternalOrganizationEnrichRequest matchingIdentifiers(List<ExternalOrganizationIdentifier> matchingIdentifiers)

An ordered list of one or more Identifiers which might each be claimed by an External Organization. `action` describes what to do with any possibly matching External Organization. Identifier lookups will occur in the order specified here.

getMatchingIdentifiers

public List<ExternalOrganizationIdentifier> getMatchingIdentifiers()

setMatchingIdentifiers

public void setMatchingIdentifiers(List<ExternalOrganizationIdentifier> matchingIdentifiers)

action

public ExternalOrganizationEnrichRequest action(ExternalOrganizationEnrichRequest.ActionEnum action)

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

getAction

public ExternalOrganizationEnrichRequest.ActionEnum getAction()

setAction

public void setAction(ExternalOrganizationEnrichRequest.ActionEnum action)

externalOrganization

public ExternalOrganizationEnrichRequest externalOrganization(ExternalOrganization externalOrganization)

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

getExternalOrganization

public ExternalOrganization getExternalOrganization()

setExternalOrganization

public void setExternalOrganization(ExternalOrganization externalOrganization)

fieldRules

public ExternalOrganizationEnrichRequest 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)

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