Package io.moov.sdk.models.components

Class ReceiptRequest

java.lang.Object

io.moov.sdk.models.components.ReceiptRequest

public class ReceiptRequest
extends java.lang.Object

ReceiptRequest

A receipt request for a specific transfer, schedule, or schedule occurrence.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReceiptRequest.Builder

Constructor Summary

Constructors

Constructor	Description
ReceiptRequest(ReceiptKind kind)
ReceiptRequest(ReceiptKind kind, java.util.Optional<java.lang.String> email, java.util.Optional<java.lang.String> emailAccountID, java.util.Optional<java.lang.String> forTransferID, java.util.Optional<java.lang.String> forScheduleID, java.util.Optional<java.lang.String> forOccurrenceID)

Method Summary

Modifier and Type	Method	Description
static ReceiptRequest.Builder	builder()
java.util.Optional<java.lang.String>	email()	The email address to send the receipt to.
java.util.Optional<java.lang.String>	emailAccountID()	The accountID to send the receipt to.
boolean	equals(java.lang.Object o)
java.util.Optional<java.lang.String>	forOccurrenceID()	The ID of the schedule occurrence associated with this receipt.
java.util.Optional<java.lang.String>	forScheduleID()	The ID of the schedule associated with this receipt.
java.util.Optional<java.lang.String>	forTransferID()	The ID of the transfer associated with this receipt.
int	hashCode()
ReceiptKind	kind()	The type of receipt being requested.
java.lang.String	toString()
ReceiptRequest	withEmail(java.lang.String email)	The email address to send the receipt to.
ReceiptRequest	withEmail(java.util.Optional<java.lang.String> email)	The email address to send the receipt to.
ReceiptRequest	withEmailAccountID(java.lang.String emailAccountID)	The accountID to send the receipt to.
ReceiptRequest	withEmailAccountID(java.util.Optional<java.lang.String> emailAccountID)	The accountID to send the receipt to.
ReceiptRequest	withForOccurrenceID(java.lang.String forOccurrenceID)	The ID of the schedule occurrence associated with this receipt.
ReceiptRequest	withForOccurrenceID(java.util.Optional<java.lang.String> forOccurrenceID)	The ID of the schedule occurrence associated with this receipt.
ReceiptRequest	withForScheduleID(java.lang.String forScheduleID)	The ID of the schedule associated with this receipt.
ReceiptRequest	withForScheduleID(java.util.Optional<java.lang.String> forScheduleID)	The ID of the schedule associated with this receipt.
ReceiptRequest	withForTransferID(java.lang.String forTransferID)	The ID of the transfer associated with this receipt.
ReceiptRequest	withForTransferID(java.util.Optional<java.lang.String> forTransferID)	The ID of the transfer associated with this receipt.
ReceiptRequest	withKind(ReceiptKind kind)	The type of receipt being requested.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiptRequest

public ReceiptRequest(ReceiptKind kind,
                      java.util.Optional<java.lang.String> email,
                      java.util.Optional<java.lang.String> emailAccountID,
                      java.util.Optional<java.lang.String> forTransferID,
                      java.util.Optional<java.lang.String> forScheduleID,
                      java.util.Optional<java.lang.String> forOccurrenceID)

ReceiptRequest

public ReceiptRequest(ReceiptKind kind)

Method Detail

kind

public ReceiptKind kind()

The type of receipt being requested.

email

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

The email address to send the receipt to. Either email or emailAccountID must be provided, but not both.

emailAccountID

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

The accountID to send the receipt to. Either email or emailAccountID must be provided, but not both.

forTransferID

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

The ID of the transfer associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

forScheduleID

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

The ID of the schedule associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

forOccurrenceID

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

The ID of the schedule occurrence associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

builder

public static final ReceiptRequest.Builder builder()

withKind

public ReceiptRequest withKind(ReceiptKind kind)

The type of receipt being requested.

withEmail

public ReceiptRequest withEmail(java.lang.String email)

The email address to send the receipt to. Either email or emailAccountID must be provided, but not both.

withEmail

public ReceiptRequest withEmail(java.util.Optional<java.lang.String> email)

The email address to send the receipt to. Either email or emailAccountID must be provided, but not both.

withEmailAccountID

public ReceiptRequest withEmailAccountID(java.lang.String emailAccountID)

The accountID to send the receipt to. Either email or emailAccountID must be provided, but not both.

withEmailAccountID

public ReceiptRequest withEmailAccountID(java.util.Optional<java.lang.String> emailAccountID)

The accountID to send the receipt to. Either email or emailAccountID must be provided, but not both.

withForTransferID

public ReceiptRequest withForTransferID(java.lang.String forTransferID)

The ID of the transfer associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

withForTransferID

public ReceiptRequest withForTransferID(java.util.Optional<java.lang.String> forTransferID)

The ID of the transfer associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

withForScheduleID

public ReceiptRequest withForScheduleID(java.lang.String forScheduleID)

The ID of the schedule associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

withForScheduleID

public ReceiptRequest withForScheduleID(java.util.Optional<java.lang.String> forScheduleID)

The ID of the schedule associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

withForOccurrenceID

public ReceiptRequest withForOccurrenceID(java.lang.String forOccurrenceID)

The ID of the schedule occurrence associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

withForOccurrenceID

public ReceiptRequest withForOccurrenceID(java.util.Optional<java.lang.String> forOccurrenceID)

The ID of the schedule occurrence associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object