Class ExternalContact

java.lang.Object
com.mypurecloud.sdk.v2.model.ExternalContact
All Implemented Interfaces:
Serializable

public class ExternalContact extends Object implements Serializable
ExternalContact
See Also:
  • Constructor Details

    • ExternalContact

      public ExternalContact()
    • ExternalContact

      public ExternalContact(Boolean initWithEmptyList)
  • Method Details

    • id

      public ExternalContact id(String id)
      The globally unique identifier for the object.
    • getId

      public String getId()
    • setId

      public void setId(String id)
    • division

      public ExternalContact division(WritableStarrableDivision division)
      The division to which this entity belongs.
    • getDivision

      public WritableStarrableDivision getDivision()
    • setDivision

      public void setDivision(WritableStarrableDivision division)
    • firstName

      public ExternalContact firstName(String firstName)
      The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
    • getFirstName

      public String getFirstName()
    • setFirstName

      public void setFirstName(String firstName)
    • middleName

      public ExternalContact middleName(String middleName)
      The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
    • getMiddleName

      public String getMiddleName()
    • setMiddleName

      public void setMiddleName(String middleName)
    • lastName

      public ExternalContact lastName(String lastName)
      The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
    • getLastName

      public String getLastName()
    • setLastName

      public void setLastName(String lastName)
    • salutation

      public ExternalContact salutation(String salutation)
      The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
    • getSalutation

      public String getSalutation()
    • setSalutation

      public void setSalutation(String salutation)
    • title

      public ExternalContact title(String title)
      The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
    • getTitle

      public String getTitle()
    • setTitle

      public void setTitle(String title)
    • workPhone

      public ExternalContact workPhone(PhoneNumber workPhone)
    • getWorkPhone

      public PhoneNumber getWorkPhone()
    • setWorkPhone

      public void setWorkPhone(PhoneNumber workPhone)
    • cellPhone

      public ExternalContact cellPhone(PhoneNumber cellPhone)
    • getCellPhone

      public PhoneNumber getCellPhone()
    • setCellPhone

      public void setCellPhone(PhoneNumber cellPhone)
    • homePhone

      public ExternalContact homePhone(PhoneNumber homePhone)
    • getHomePhone

      public PhoneNumber getHomePhone()
    • setHomePhone

      public void setHomePhone(PhoneNumber homePhone)
    • otherPhone

      public ExternalContact otherPhone(PhoneNumber otherPhone)
    • getOtherPhone

      public PhoneNumber getOtherPhone()
    • setOtherPhone

      public void setOtherPhone(PhoneNumber otherPhone)
    • workEmail

      public ExternalContact workEmail(String workEmail)
      The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
    • getWorkEmail

      public String getWorkEmail()
    • setWorkEmail

      public void setWorkEmail(String workEmail)
    • personalEmail

      public ExternalContact personalEmail(String personalEmail)
      The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
    • getPersonalEmail

      public String getPersonalEmail()
    • setPersonalEmail

      public void setPersonalEmail(String personalEmail)
    • otherEmail

      public ExternalContact otherEmail(String otherEmail)
      The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
    • getOtherEmail

      public String getOtherEmail()
    • setOtherEmail

      public void setOtherEmail(String otherEmail)
    • address

      public ExternalContact address(ContactAddress address)
    • getAddress

      public ContactAddress getAddress()
    • setAddress

      public void setAddress(ContactAddress address)
    • twitterId

      public ExternalContact twitterId(TwitterId twitterId)
      User information for a Twitter account
    • getTwitterId

      public TwitterId getTwitterId()
    • setTwitterId

      public void setTwitterId(TwitterId twitterId)
    • lineId

      public ExternalContact lineId(LineId lineId)
    • getLineId

      public LineId getLineId()
    • setLineId

      public void setLineId(LineId lineId)
    • whatsAppId

      public ExternalContact whatsAppId(WhatsAppId whatsAppId)
      User information for a WhatsApp account
    • getWhatsAppId

      public WhatsAppId getWhatsAppId()
    • setWhatsAppId

      public void setWhatsAppId(WhatsAppId whatsAppId)
    • facebookId

      public ExternalContact facebookId(FacebookId facebookId)
      User information for a Facebook account
    • getFacebookId

      public FacebookId getFacebookId()
    • setFacebookId

      public void setFacebookId(FacebookId facebookId)
    • instagramId

      public ExternalContact instagramId(InstagramId instagramId)
      User information for an Instagram account
    • getInstagramId

      public InstagramId getInstagramId()
    • setInstagramId

      public void setInstagramId(InstagramId instagramId)
    • appleOpaqueIds

      public ExternalContact appleOpaqueIds(List<AppleOpaqueId> appleOpaqueIds)
      User information for an Apple account. Max: 10 ids
    • getAppleOpaqueIds

      public List<AppleOpaqueId> getAppleOpaqueIds()
    • setAppleOpaqueIds

      public void setAppleOpaqueIds(List<AppleOpaqueId> appleOpaqueIds)
    • externalIds

      public ExternalContact externalIds(List<ExternalId> externalIds)
      A list of external identifiers that identify this contact in an external system. Max: 10 ids
    • getExternalIds

      public List<ExternalId> getExternalIds()
    • setExternalIds

      public void setExternalIds(List<ExternalId> externalIds)
    • identifiers

      public ExternalContact identifiers(List<ContactIdentifier> identifiers)
      Identifiers claimed by this contact
    • getIdentifiers

      public List<ContactIdentifier> getIdentifiers()
    • setIdentifiers

      public void setIdentifiers(List<ContactIdentifier> identifiers)
    • modifyDate

      public ExternalContact modifyDate(Date modifyDate)
      Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getModifyDate

      public Date getModifyDate()
    • setModifyDate

      public void setModifyDate(Date modifyDate)
    • createDate

      public ExternalContact createDate(Date createDate)
      Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getCreateDate

      public Date getCreateDate()
    • setCreateDate

      public void setCreateDate(Date createDate)
    • externalOrganization

      public ExternalContact externalOrganization(ExternalOrganization externalOrganization)
    • getExternalOrganization

      public ExternalOrganization getExternalOrganization()
    • setExternalOrganization

      public void setExternalOrganization(ExternalOrganization externalOrganization)
    • surveyOptOut

      public ExternalContact surveyOptOut(Boolean surveyOptOut)
    • getSurveyOptOut

      public Boolean getSurveyOptOut()
    • setSurveyOptOut

      public void setSurveyOptOut(Boolean surveyOptOut)
    • externalSystemUrl

      public ExternalContact externalSystemUrl(String externalSystemUrl)
      A string that identifies an external system-of-record resource that may have more detailed information on the contact. Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 1000 characters.
    • getExternalSystemUrl

      public String getExternalSystemUrl()
    • setExternalSystemUrl

      public void setExternalSystemUrl(String externalSystemUrl)
    • schema

      public ExternalContact schema(DataSchema schema)
      The schema defining custom fields for this contact
    • getSchema

      public DataSchema getSchema()
    • setSchema

      public void setSchema(DataSchema schema)
    • customFields

      public ExternalContact customFields(Map<String,Object> customFields)
      Custom fields defined in the schema referenced by schemaId and schemaVersion.
    • getCustomFields

      public Map<String,Object> getCustomFields()
    • setCustomFields

      public void setCustomFields(Map<String,Object> customFields)
    • getExternalDataSources

      public List<ExternalDataSource> getExternalDataSources()
    • getType

      public ExternalContact.TypeEnum getType()
    • getCanonicalContact

      public ContactAddressableEntityRef getCanonicalContact()
    • getMergeSet

      public List<ContactAddressableEntityRef> getMergeSet()
    • getMergedFrom

      public List<ContactAddressableEntityRef> getMergedFrom()
    • getMergedTo

      public ContactAddressableEntityRef getMergedTo()
    • getMergeOperation

      public MergeOperation getMergeOperation()
    • getSelfUri

      public String getSelfUri()
    • 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