com.squareup.square.models

Class InvoicePaymentReminder

java.lang.Object

com.squareup.square.models.InvoicePaymentReminder

public class InvoicePaymentReminder
extends Object

This is a model class for InvoicePaymentReminder type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InvoicePaymentReminder.Builder Class to build instances of InvoicePaymentReminder.

Constructor Summary

Constructors

Constructor and Description
InvoicePaymentReminder(String uid, Integer relativeScheduledDays, String message, String status, String sentAt) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMessage() Getter for Message.
Integer	getRelativeScheduledDays() Getter for RelativeScheduledDays.
String	getSentAt() Getter for SentAt.
String	getStatus() Getter for Status.
String	getUid() Getter for Uid.
int	hashCode()
InvoicePaymentReminder.Builder	toBuilder() Builds a new InvoicePaymentReminder.Builder object.
String	toString() Converts this InvoicePaymentReminder into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

InvoicePaymentReminder

public InvoicePaymentReminder(String uid,
                              Integer relativeScheduledDays,
                              String message,
                              String status,
                              String sentAt)

Initialization constructor.

Parameters:

uid - String value for uid.

relativeScheduledDays - Integer value for relativeScheduledDays.

message - String value for message.

status - String value for status.

sentAt - String value for sentAt.

Method Detail

getUid

public String getUid()

Getter for Uid. A Square-assigned ID that uniquely identifies the reminder within the `InvoicePaymentRequest`.

Returns:

Returns the String

getRelativeScheduledDays

public Integer getRelativeScheduledDays()

Getter for RelativeScheduledDays. The number of days before (a negative number) or after (a positive number) the payment request `due_date` when the reminder is sent. For example, -3 indicates that the reminder should be sent 3 days before the payment request `due_date`.

Returns:

Returns the Integer

getMessage

public String getMessage()

Getter for Message. The reminder message.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. The status of a payment request reminder.

Returns:

Returns the String

getSentAt

public String getSentAt()

Getter for SentAt. If sent, the timestamp when the reminder was sent, in RFC 3339 format.

Returns:

Returns the String

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this InvoicePaymentReminder into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public InvoicePaymentReminder.Builder toBuilder()

Builds a new InvoicePaymentReminder.Builder object. Creates the instance with the state of the current model.

Returns:

a new InvoicePaymentReminder.Builder object