Package com.courier.api.resources.tenants.types

Class Tenant.Builder

java.lang.Object

com.courier.api.resources.tenants.types.Tenant.Builder

All Implemented Interfaces:

Tenant._FinalStage, Tenant.IdStage, Tenant.NameStage

Enclosing class:

Tenant

public static final class Tenant.Builder
extends java.lang.Object
implements Tenant.IdStage, Tenant.NameStage, Tenant._FinalStage

Method Summary

Modifier and Type	Method	Description
Tenant._FinalStage	brandId(java.lang.String brandId)	Brand to be used for the account when one is not specified by the send call.
Tenant._FinalStage	brandId(java.util.Optional<java.lang.String> brandId)
Tenant	build()
Tenant._FinalStage	defaultPreferences(DefaultPreferences defaultPreferences)	Defines the preferences used for the account when the user hasn't specified their own.
Tenant._FinalStage	defaultPreferences(java.util.Optional<DefaultPreferences> defaultPreferences)
Tenant.Builder	from(Tenant other)
Tenant.NameStage	id(java.lang.String id)	Id of the tenant.
Tenant._FinalStage	name(java.lang.String name)	Name of the tenant.
Tenant._FinalStage	parentTenantId(java.lang.String parentTenantId)	Tenant's parent id (if any).
Tenant._FinalStage	parentTenantId(java.util.Optional<java.lang.String> parentTenantId)
Tenant._FinalStage	properties(java.util.Map<java.lang.String,java.lang.Object> properties)	Arbitrary properties accessible to a template.
Tenant._FinalStage	properties(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> properties)
Tenant._FinalStage	userProfile(java.util.Map<java.lang.String,java.lang.Object> userProfile)	A user profile object merged with user profile on send.
Tenant._FinalStage	userProfile(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> userProfile)

Methods inherited from class java.lang.Object

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

Method Detail

from

public Tenant.Builder from(Tenant other)

Specified by:

from in interface Tenant.IdStage

id

public Tenant.NameStage id(java.lang.String id)

Id of the tenant.

Specified by:

id in interface Tenant.IdStage

Returns:

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

name

public Tenant._FinalStage name(java.lang.String name)

Name of the tenant.

Specified by:

name in interface Tenant.NameStage

Returns:

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

brandId

public Tenant._FinalStage brandId(java.lang.String brandId)

Brand to be used for the account when one is not specified by the send call.

Specified by:

brandId in interface Tenant._FinalStage

Returns:

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

brandId

public Tenant._FinalStage brandId(java.util.Optional<java.lang.String> brandId)

Specified by:

brandId in interface Tenant._FinalStage

userProfile

public Tenant._FinalStage userProfile(java.util.Map<java.lang.String,java.lang.Object> userProfile)

A user profile object merged with user profile on send.

Specified by:

userProfile in interface Tenant._FinalStage

Returns:

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

userProfile

public Tenant._FinalStage userProfile(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> userProfile)

Specified by:

userProfile in interface Tenant._FinalStage

properties

public Tenant._FinalStage properties(java.util.Map<java.lang.String,java.lang.Object> properties)

Arbitrary properties accessible to a template.

Specified by:

properties in interface Tenant._FinalStage

Returns:

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

properties

public Tenant._FinalStage properties(java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> properties)

Specified by:

properties in interface Tenant._FinalStage

defaultPreferences

public Tenant._FinalStage defaultPreferences(DefaultPreferences defaultPreferences)

Defines the preferences used for the account when the user hasn't specified their own.

Specified by:

defaultPreferences in interface Tenant._FinalStage

Returns:

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

defaultPreferences

public Tenant._FinalStage defaultPreferences(java.util.Optional<DefaultPreferences> defaultPreferences)

Specified by:

defaultPreferences in interface Tenant._FinalStage

parentTenantId

public Tenant._FinalStage parentTenantId(java.lang.String parentTenantId)

Tenant's parent id (if any).

Specified by:

parentTenantId in interface Tenant._FinalStage

Returns:

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

parentTenantId

public Tenant._FinalStage parentTenantId(java.util.Optional<java.lang.String> parentTenantId)

Specified by:

parentTenantId in interface Tenant._FinalStage

build

public Tenant build()

Specified by:

build in interface Tenant._FinalStage