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

Class DataAttribute.Builder

java.lang.Object

com.intercom.api.resources.dataattributes.types.DataAttribute.Builder

All Implemented Interfaces:

DataAttribute._FinalStage, DataAttribute.DataTypeStage, DataAttribute.DescriptionStage, DataAttribute.FullNameStage, DataAttribute.LabelStage, DataAttribute.NameStage

Enclosing class:

DataAttribute

public static final class DataAttribute.Builder
extends Object
implements DataAttribute.NameStage, DataAttribute.FullNameStage, DataAttribute.LabelStage, DataAttribute.DescriptionStage, DataAttribute.DataTypeStage, DataAttribute._FinalStage

Method Summary

Modifier and Type	Method	Description
DataAttribute._FinalStage	adminId(String adminId)	Teammate who created the attribute.
DataAttribute._FinalStage	adminId(Optional<String> adminId)
DataAttribute._FinalStage	apiWritable(Boolean apiWritable)	Can this attribute be updated through API
DataAttribute._FinalStage	apiWritable(Optional<Boolean> apiWritable)
DataAttribute._FinalStage	archived(Boolean archived)	Is this attribute archived.
DataAttribute._FinalStage	archived(Optional<Boolean> archived)
DataAttribute	build()
DataAttribute._FinalStage	createdAt(Integer createdAt)	The time the attribute was created as a UTC Unix timestamp
DataAttribute._FinalStage	createdAt(Optional<Integer> createdAt)
DataAttribute._FinalStage	custom(Boolean custom)	Set to true if this is a CDA
DataAttribute._FinalStage	custom(Optional<Boolean> custom)
DataAttribute._FinalStage	dataType(DataAttribute.DataType dataType)	The data type of the attribute.
DataAttribute.DataTypeStage	description(String description)	Readable description of the attribute.
DataAttribute.Builder	from(DataAttribute other)
DataAttribute.LabelStage	fullName(String fullName)	Full name of the attribute.
DataAttribute._FinalStage	id(Integer id)	The unique identifier for the data attribute which is given by Intercom.
DataAttribute._FinalStage	id(Optional<Integer> id)
DataAttribute.DescriptionStage	label(String label)	Readable name of the attribute (i.e.
DataAttribute._FinalStage	messengerWritable(Boolean messengerWritable)	Can this attribute be updated by the Messenger
DataAttribute._FinalStage	messengerWritable(Optional<Boolean> messengerWritable)
DataAttribute._FinalStage	model(DataAttribute.Model model)	Value is contact for user/lead attributes and company for company attributes.
DataAttribute._FinalStage	model(Optional<DataAttribute.Model> model)
DataAttribute.FullNameStage	name(String name)	Name of the attribute.
DataAttribute._FinalStage	options(List<String> options)	List of predefined options for attribute value.
DataAttribute._FinalStage	options(Optional<List<String>> options)
DataAttribute._FinalStage	uiWritable(Boolean uiWritable)	Can this attribute be updated in the UI
DataAttribute._FinalStage	uiWritable(Optional<Boolean> uiWritable)
DataAttribute._FinalStage	updatedAt(Integer updatedAt)	The time the attribute was last updated as a UTC Unix timestamp
DataAttribute._FinalStage	updatedAt(Optional<Integer> updatedAt)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public DataAttribute.Builder from(DataAttribute other)

Specified by:

from in interface DataAttribute.NameStage

name

public DataAttribute.FullNameStage name(@NotNull
 String name)

Name of the attribute.

Specified by:

name in interface DataAttribute.NameStage

Returns:

Reference to this so that method calls can be chained together.

fullName

public DataAttribute.LabelStage fullName(@NotNull
 String fullName)

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.

Specified by:

fullName in interface DataAttribute.FullNameStage

Returns:

Reference to this so that method calls can be chained together.

label

public DataAttribute.DescriptionStage label(@NotNull
 String label)

Readable name of the attribute (i.e. name you see in the UI)

Specified by:

label in interface DataAttribute.LabelStage

Returns:

Reference to this so that method calls can be chained together.

description

public DataAttribute.DataTypeStage description(@NotNull
 String description)

Readable description of the attribute.

Specified by:

description in interface DataAttribute.DescriptionStage

Returns:

Reference to this so that method calls can be chained together.

dataType

public DataAttribute._FinalStage dataType(@NotNull
 DataAttribute.DataType dataType)

The data type of the attribute.

Specified by:

dataType in interface DataAttribute.DataTypeStage

Returns:

Reference to this so that method calls can be chained together.

adminId

public DataAttribute._FinalStage adminId(String adminId)

Teammate who created the attribute. Only applicable to CDAs

Specified by:

adminId in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

adminId

public DataAttribute._FinalStage adminId(Optional<String> adminId)

Specified by:

adminId in interface DataAttribute._FinalStage

updatedAt

public DataAttribute._FinalStage updatedAt(Integer updatedAt)

The time the attribute was last updated as a UTC Unix timestamp

Specified by:

updatedAt in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

updatedAt

public DataAttribute._FinalStage updatedAt(Optional<Integer> updatedAt)

Specified by:

updatedAt in interface DataAttribute._FinalStage

createdAt

public DataAttribute._FinalStage createdAt(Integer createdAt)

The time the attribute was created as a UTC Unix timestamp

Specified by:

createdAt in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

createdAt

public DataAttribute._FinalStage createdAt(Optional<Integer> createdAt)

Specified by:

createdAt in interface DataAttribute._FinalStage

archived

public DataAttribute._FinalStage archived(Boolean archived)

Is this attribute archived. (Only applicable to CDAs)

Specified by:

archived in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

archived

public DataAttribute._FinalStage archived(Optional<Boolean> archived)

Specified by:

archived in interface DataAttribute._FinalStage

custom

public DataAttribute._FinalStage custom(Boolean custom)

Set to true if this is a CDA

Specified by:

custom in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

custom

public DataAttribute._FinalStage custom(Optional<Boolean> custom)

Specified by:

custom in interface DataAttribute._FinalStage

uiWritable

public DataAttribute._FinalStage uiWritable(Boolean uiWritable)

Can this attribute be updated in the UI

Specified by:

uiWritable in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

uiWritable

public DataAttribute._FinalStage uiWritable(Optional<Boolean> uiWritable)

Specified by:

uiWritable in interface DataAttribute._FinalStage

messengerWritable

public DataAttribute._FinalStage messengerWritable(Boolean messengerWritable)

Can this attribute be updated by the Messenger

Specified by:

messengerWritable in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

messengerWritable

public DataAttribute._FinalStage messengerWritable(Optional<Boolean> messengerWritable)

Specified by:

messengerWritable in interface DataAttribute._FinalStage

apiWritable

public DataAttribute._FinalStage apiWritable(Boolean apiWritable)

Can this attribute be updated through API

Specified by:

apiWritable in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

apiWritable

public DataAttribute._FinalStage apiWritable(Optional<Boolean> apiWritable)

Specified by:

apiWritable in interface DataAttribute._FinalStage

options

public DataAttribute._FinalStage options(List<String> options)

List of predefined options for attribute value.

Specified by:

options in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

options

public DataAttribute._FinalStage options(Optional<List<String>> options)

Specified by:

options in interface DataAttribute._FinalStage

model

public DataAttribute._FinalStage model(DataAttribute.Model model)

Value is contact for user/lead attributes and company for company attributes.

Specified by:

model in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

model

public DataAttribute._FinalStage model(Optional<DataAttribute.Model> model)

Specified by:

model in interface DataAttribute._FinalStage

id

public DataAttribute._FinalStage id(Integer id)

The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes.

Specified by:

id in interface DataAttribute._FinalStage

Returns:

Reference to this so that method calls can be chained together.

id

public DataAttribute._FinalStage id(Optional<Integer> id)

Specified by:

id in interface DataAttribute._FinalStage

build

public DataAttribute build()

Specified by:

build in interface DataAttribute._FinalStage