Class Contact.Builder

  • Enclosing class:
    Contact

    public static final class Contact.Builder
    extends java.lang.Object
    • Method Detail

      • type

        public Contact.Builder type​(java.util.Optional<java.lang.String> type)

        The type of object.

      • id

        public Contact.Builder id​(java.util.Optional<java.lang.String> id)

        The unique identifier for the contact which is given by Intercom.

      • externalId

        public Contact.Builder externalId​(java.util.Optional<java.lang.String> externalId)

        The unique identifier for the contact which is provided by the Client.

      • externalId

        public Contact.Builder externalId​(java.lang.String externalId)
      • workspaceId

        public Contact.Builder workspaceId​(java.util.Optional<java.lang.String> workspaceId)

        The id of the workspace which the contact belongs to.

      • workspaceId

        public Contact.Builder workspaceId​(java.lang.String workspaceId)
      • role

        public Contact.Builder role​(java.util.Optional<java.lang.String> role)

        The role of the contact.

      • email

        public Contact.Builder email​(java.util.Optional<java.lang.String> email)

        The contact's email.

      • emailDomain

        public Contact.Builder emailDomain​(java.util.Optional<java.lang.String> emailDomain)

        The contact's email domain.

      • emailDomain

        public Contact.Builder emailDomain​(java.lang.String emailDomain)
      • phone

        public Contact.Builder phone​(java.util.Optional<java.lang.String> phone)

        The contacts phone.

      • name

        public Contact.Builder name​(java.util.Optional<java.lang.String> name)

        The contacts name.

      • ownerId

        public Contact.Builder ownerId​(java.util.Optional<java.lang.Integer> ownerId)

        The id of an admin that has been assigned account ownership of the contact.

      • hasHardBounced

        public Contact.Builder hasHardBounced​(java.util.Optional<java.lang.Boolean> hasHardBounced)

        Whether the contact has had an email sent to them hard bounce.

      • hasHardBounced

        public Contact.Builder hasHardBounced​(java.lang.Boolean hasHardBounced)
      • markedEmailAsSpam

        public Contact.Builder markedEmailAsSpam​(java.util.Optional<java.lang.Boolean> markedEmailAsSpam)

        Whether the contact has marked an email sent to them as spam.

      • markedEmailAsSpam

        public Contact.Builder markedEmailAsSpam​(java.lang.Boolean markedEmailAsSpam)
      • unsubscribedFromEmails

        public Contact.Builder unsubscribedFromEmails​(java.util.Optional<java.lang.Boolean> unsubscribedFromEmails)

        Whether the contact is unsubscribed from emails.

      • unsubscribedFromEmails

        public Contact.Builder unsubscribedFromEmails​(java.lang.Boolean unsubscribedFromEmails)
      • createdAt

        public Contact.Builder createdAt​(java.util.Optional<java.lang.Integer> createdAt)

        (UNIX timestamp) The time when the contact was created.

      • createdAt

        public Contact.Builder createdAt​(java.lang.Integer createdAt)
      • updatedAt

        public Contact.Builder updatedAt​(java.util.Optional<java.lang.Integer> updatedAt)

        (UNIX timestamp) The time when the contact was last updated.

      • updatedAt

        public Contact.Builder updatedAt​(java.lang.Integer updatedAt)
      • signedUpAt

        public Contact.Builder signedUpAt​(java.util.Optional<java.lang.Integer> signedUpAt)

        (UNIX timestamp) The time specified for when a contact signed up.

      • signedUpAt

        public Contact.Builder signedUpAt​(java.lang.Integer signedUpAt)
      • lastSeenAt

        public Contact.Builder lastSeenAt​(java.util.Optional<java.lang.Integer> lastSeenAt)

        (UNIX timestamp) The time when the contact was last seen (either where the Intercom Messenger was installed or when specified manually).

      • lastSeenAt

        public Contact.Builder lastSeenAt​(java.lang.Integer lastSeenAt)
      • lastRepliedAt

        public Contact.Builder lastRepliedAt​(java.util.Optional<java.lang.Integer> lastRepliedAt)

        (UNIX timestamp) The time when the contact last messaged in.

      • lastRepliedAt

        public Contact.Builder lastRepliedAt​(java.lang.Integer lastRepliedAt)
      • lastContactedAt

        public Contact.Builder lastContactedAt​(java.util.Optional<java.lang.Integer> lastContactedAt)

        (UNIX timestamp) The time when the contact was last messaged.

      • lastContactedAt

        public Contact.Builder lastContactedAt​(java.lang.Integer lastContactedAt)
      • lastEmailOpenedAt

        public Contact.Builder lastEmailOpenedAt​(java.util.Optional<java.lang.Integer> lastEmailOpenedAt)

        (UNIX timestamp) The time when the contact last opened an email.

      • lastEmailOpenedAt

        public Contact.Builder lastEmailOpenedAt​(java.lang.Integer lastEmailOpenedAt)
      • lastEmailClickedAt

        public Contact.Builder lastEmailClickedAt​(java.util.Optional<java.lang.Integer> lastEmailClickedAt)

        (UNIX timestamp) The time when the contact last clicked a link in an email.

      • lastEmailClickedAt

        public Contact.Builder lastEmailClickedAt​(java.lang.Integer lastEmailClickedAt)
      • languageOverride

        public Contact.Builder languageOverride​(java.util.Optional<java.lang.String> languageOverride)

        A preferred language setting for the contact, used by the Intercom Messenger even if their browser settings change.

      • languageOverride

        public Contact.Builder languageOverride​(java.lang.String languageOverride)
      • browser

        public Contact.Builder browser​(java.util.Optional<java.lang.String> browser)

        The name of the browser which the contact is using.

      • browserVersion

        public Contact.Builder browserVersion​(java.util.Optional<java.lang.String> browserVersion)

        The version of the browser which the contact is using.

      • browserVersion

        public Contact.Builder browserVersion​(java.lang.String browserVersion)
      • browserLanguage

        public Contact.Builder browserLanguage​(java.util.Optional<java.lang.String> browserLanguage)

        The language set by the browser which the contact is using.

      • browserLanguage

        public Contact.Builder browserLanguage​(java.lang.String browserLanguage)
      • os

        public Contact.Builder os​(java.util.Optional<java.lang.String> os)

        The operating system which the contact is using.

      • androidAppName

        public Contact.Builder androidAppName​(java.util.Optional<java.lang.String> androidAppName)

        The name of the Android app which the contact is using.

      • androidAppName

        public Contact.Builder androidAppName​(java.lang.String androidAppName)
      • androidAppVersion

        public Contact.Builder androidAppVersion​(java.util.Optional<java.lang.String> androidAppVersion)

        The version of the Android app which the contact is using.

      • androidAppVersion

        public Contact.Builder androidAppVersion​(java.lang.String androidAppVersion)
      • androidDevice

        public Contact.Builder androidDevice​(java.util.Optional<java.lang.String> androidDevice)

        The Android device which the contact is using.

      • androidDevice

        public Contact.Builder androidDevice​(java.lang.String androidDevice)
      • androidOsVersion

        public Contact.Builder androidOsVersion​(java.util.Optional<java.lang.String> androidOsVersion)

        The version of the Android OS which the contact is using.

      • androidOsVersion

        public Contact.Builder androidOsVersion​(java.lang.String androidOsVersion)
      • androidSdkVersion

        public Contact.Builder androidSdkVersion​(java.util.Optional<java.lang.String> androidSdkVersion)

        The version of the Android SDK which the contact is using.

      • androidSdkVersion

        public Contact.Builder androidSdkVersion​(java.lang.String androidSdkVersion)
      • androidLastSeenAt

        public Contact.Builder androidLastSeenAt​(java.util.Optional<java.lang.Integer> androidLastSeenAt)

        (UNIX timestamp) The time when the contact was last seen on an Android device.

      • androidLastSeenAt

        public Contact.Builder androidLastSeenAt​(java.lang.Integer androidLastSeenAt)
      • iosAppName

        public Contact.Builder iosAppName​(java.util.Optional<java.lang.String> iosAppName)

        The name of the iOS app which the contact is using.

      • iosAppName

        public Contact.Builder iosAppName​(java.lang.String iosAppName)
      • iosAppVersion

        public Contact.Builder iosAppVersion​(java.util.Optional<java.lang.String> iosAppVersion)

        The version of the iOS app which the contact is using.

      • iosAppVersion

        public Contact.Builder iosAppVersion​(java.lang.String iosAppVersion)
      • iosDevice

        public Contact.Builder iosDevice​(java.util.Optional<java.lang.String> iosDevice)

        The iOS device which the contact is using.

      • iosDevice

        public Contact.Builder iosDevice​(java.lang.String iosDevice)
      • iosOsVersion

        public Contact.Builder iosOsVersion​(java.util.Optional<java.lang.String> iosOsVersion)

        The version of iOS which the contact is using.

      • iosOsVersion

        public Contact.Builder iosOsVersion​(java.lang.String iosOsVersion)
      • iosSdkVersion

        public Contact.Builder iosSdkVersion​(java.util.Optional<java.lang.String> iosSdkVersion)

        The version of the iOS SDK which the contact is using.

      • iosSdkVersion

        public Contact.Builder iosSdkVersion​(java.lang.String iosSdkVersion)
      • iosLastSeenAt

        public Contact.Builder iosLastSeenAt​(java.util.Optional<java.lang.Integer> iosLastSeenAt)

        (UNIX timestamp) The last time the contact used the iOS app.

      • iosLastSeenAt

        public Contact.Builder iosLastSeenAt​(java.lang.Integer iosLastSeenAt)
      • customAttributes

        public Contact.Builder customAttributes​(java.util.Optional<java.util.Map<java.lang.String,​java.lang.Object>> customAttributes)

        The custom attributes which are set for the contact.

      • customAttributes

        public Contact.Builder customAttributes​(java.util.Map<java.lang.String,​java.lang.Object> customAttributes)
      • avatar

        public Contact.Builder avatar​(java.util.Optional<java.lang.String> avatar)

        An image URL containing the avatar of a contact.