Package com.courier.api.resources.bulk.types

Class InboundBulkMessage

java.lang.Object

com.courier.api.resources.bulk.types.InboundBulkMessage

All Implemented Interfaces:

IInboundBulkMessageV1

public final class InboundBulkMessage
extends java.lang.Object
implements IInboundBulkMessageV1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InboundBulkMessage.Builder

Method Summary

Modifier and Type	Method	Description
static InboundBulkMessage.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<java.lang.String>	getBrand()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getData()
java.util.Optional<java.lang.String>	getEvent()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getLocale()
java.util.Optional<InboundBulkMessageV2>	getMessage()
java.util.Optional<java.lang.Object>	getOverride()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getBrand

public java.util.Optional<java.lang.String> getBrand()

Specified by:

getBrand in interface IInboundBulkMessageV1

Returns:

A unique identifier that represents the brand that should be used for rendering the notification.

getData

public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getData()

Specified by:

getData in interface IInboundBulkMessageV1

Returns:

JSON that includes any data you want to pass to a message template. The data will populate the corresponding template variables.

getEvent

public java.util.Optional<java.lang.String> getEvent()

Specified by:

getEvent in interface IInboundBulkMessageV1

getLocale

public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getLocale()

Specified by:

getLocale in interface IInboundBulkMessageV1

getOverride

public java.util.Optional<java.lang.Object> getOverride()

Specified by:

getOverride in interface IInboundBulkMessageV1

Returns:

JSON that is merged into the request sent by Courier to the provider to override properties or to gain access to features in the provider API that are not natively supported by Courier.

getMessage

public java.util.Optional<InboundBulkMessageV2> getMessage()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

getAdditionalProperties

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalProperties()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static InboundBulkMessage.Builder builder()