Package com.intercom.api.resources.dataattributes.types

Class DataAttribute

java.lang.Object
com.intercom.api.resources.dataattributes.types.DataAttribute
public final class DataAttribute extends Object

  • Method Details

    • getType

      public String getType()
      Returns:
      Value is data_attribute.

    • getId

      public Optional<Integer> getId()
      Returns:
      The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

    • getModel

      public Optional<DataAttribute.Model> getModel()
      Returns:
      Value is contact for user/lead attributes and company for company attributes.

    • getName

      public String getName()
      Returns:
      Name of the attribute.

    • getFullName

      public String getFullName()
      Returns:
      Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on . to access nested user object values.

    • getLabel

      public String getLabel()
      Returns:
      Readable name of the attribute (i.e. name you see in the UI)

    • getDescription

      public String getDescription()
      Returns:
      Readable description of the attribute.

    • getDataType

      public DataAttribute.DataType getDataType()
      Returns:
      The data type of the attribute.

    • getOptions

      public Optional<List<String>> getOptions()
      Returns:
      List of predefined options for attribute value.

    • getApiWritable

      public Optional<Boolean> getApiWritable()
      Returns:
      Can this attribute be updated through API

    • getMessengerWritable

      public Optional<Boolean> getMessengerWritable()
      Returns:
      Can this attribute be updated by the Messenger

    • getUiWritable

      public Optional<Boolean> getUiWritable()
      Returns:
      Can this attribute be updated in the UI

    • getCustom

      public Optional<Boolean> getCustom()
      Returns:
      Set to true if this is a CDA

    • getArchived

      public Optional<Boolean> getArchived()
      Returns:
      Is this attribute archived. (Only applicable to CDAs)

    • getCreatedAt

      public Optional<Integer> getCreatedAt()
      Returns:
      The time the attribute was created as a UTC Unix timestamp

    • getUpdatedAt

      public Optional<Integer> getUpdatedAt()
      Returns:
      The time the attribute was last updated as a UTC Unix timestamp

    • getAdminId

      public Optional<String> getAdminId()
      Returns:
      Teammate who created the attribute. Only applicable to CDAs

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static DataAttribute.NameStage builder()