com.squareup.square.models

Class ListPaymentsRequest

java.lang.Object

com.squareup.square.models.ListPaymentsRequest

public class ListPaymentsRequest
extends Object

This is a model class for ListPaymentsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListPaymentsRequest(io.apimatic.core.types.OptionalNullable<String> beginTime, io.apimatic.core.types.OptionalNullable<String> endTime, io.apimatic.core.types.OptionalNullable<String> sortOrder, io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<String> locationId, io.apimatic.core.types.OptionalNullable<Long> total, io.apimatic.core.types.OptionalNullable<String> last4, io.apimatic.core.types.OptionalNullable<String> cardBrand, io.apimatic.core.types.OptionalNullable<Integer> limit) Internal initialization constructor.
	ListPaymentsRequest(String beginTime, String endTime, String sortOrder, String cursor, String locationId, Long total, String last4, String cardBrand, Integer limit) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBeginTime() Getter for BeginTime.
String	getCardBrand() Getter for CardBrand.
String	getCursor() Getter for Cursor.
String	getEndTime() Getter for EndTime.
String	getLast4() Getter for Last4.
Integer	getLimit() Getter for Limit.
String	getLocationId() Getter for LocationId.
String	getSortOrder() Getter for SortOrder.
Long	getTotal() Getter for Total.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetBeginTime() Internal Getter for BeginTime.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCardBrand() Internal Getter for CardBrand.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetCursor() Internal Getter for Cursor.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetEndTime() Internal Getter for EndTime.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetLast4() Internal Getter for Last4.
protected io.apimatic.core.types.OptionalNullable<Integer>	internalGetLimit() Internal Getter for Limit.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetLocationId() Internal Getter for LocationId.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetSortOrder() Internal Getter for SortOrder.
protected io.apimatic.core.types.OptionalNullable<Long>	internalGetTotal() Internal Getter for Total.
ListPaymentsRequest.Builder	toBuilder() Builds a new ListPaymentsRequest.Builder object.
String	toString() Converts this ListPaymentsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPaymentsRequest

public ListPaymentsRequest(String beginTime,
                           String endTime,
                           String sortOrder,
                           String cursor,
                           String locationId,
                           Long total,
                           String last4,
                           String cardBrand,
                           Integer limit)

Initialization constructor.

Parameters:

beginTime - String value for beginTime.

endTime - String value for endTime.

sortOrder - String value for sortOrder.

cursor - String value for cursor.

locationId - String value for locationId.

total - Long value for total.

last4 - String value for last4.

cardBrand - String value for cardBrand.

limit - Integer value for limit.

ListPaymentsRequest

protected ListPaymentsRequest(io.apimatic.core.types.OptionalNullable<String> beginTime,
                              io.apimatic.core.types.OptionalNullable<String> endTime,
                              io.apimatic.core.types.OptionalNullable<String> sortOrder,
                              io.apimatic.core.types.OptionalNullable<String> cursor,
                              io.apimatic.core.types.OptionalNullable<String> locationId,
                              io.apimatic.core.types.OptionalNullable<Long> total,
                              io.apimatic.core.types.OptionalNullable<String> last4,
                              io.apimatic.core.types.OptionalNullable<String> cardBrand,
                              io.apimatic.core.types.OptionalNullable<Integer> limit)

Internal initialization constructor.

Method Detail

internalGetBeginTime

protected io.apimatic.core.types.OptionalNullable<String> internalGetBeginTime()

Internal Getter for BeginTime. Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Inclusive. Default: The current time minus one year.

Returns:

Returns the Internal String

getBeginTime

public String getBeginTime()

Getter for BeginTime. Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Inclusive. Default: The current time minus one year.

Returns:

Returns the String

internalGetEndTime

protected io.apimatic.core.types.OptionalNullable<String> internalGetEndTime()

Internal Getter for EndTime. Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Default: The current time.

Returns:

Returns the Internal String

getEndTime

public String getEndTime()

Getter for EndTime. Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The range is determined using the `created_at` field for each Payment. Default: The current time.

Returns:

Returns the String

internalGetSortOrder

protected io.apimatic.core.types.OptionalNullable<String> internalGetSortOrder()

Internal Getter for SortOrder. The order in which results are listed by `Payment.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

Returns:

Returns the Internal String

getSortOrder

public String getSortOrder()

Getter for SortOrder. The order in which results are listed by `Payment.created_at`: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).

Returns:

Returns the String

internalGetCursor

protected io.apimatic.core.types.OptionalNullable<String> internalGetCursor()

Internal Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the Internal String

getCursor

public String getCursor()

Getter for Cursor. A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).

Returns:

Returns the String

internalGetLocationId

protected io.apimatic.core.types.OptionalNullable<String> internalGetLocationId()

Internal Getter for LocationId. Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.

Returns:

Returns the Internal String

getLocationId

public String getLocationId()

Getter for LocationId. Limit results to the location supplied. By default, results are returned for the default (main) location associated with the seller.

Returns:

Returns the String

internalGetTotal

protected io.apimatic.core.types.OptionalNullable<Long> internalGetTotal()

Internal Getter for Total. The exact amount in the `total_money` for a payment.

Returns:

Returns the Internal Long

getTotal

public Long getTotal()

Getter for Total. The exact amount in the `total_money` for a payment.

Returns:

Returns the Long

internalGetLast4

protected io.apimatic.core.types.OptionalNullable<String> internalGetLast4()

Internal Getter for Last4. The last four digits of a payment card.

Returns:

Returns the Internal String

getLast4

public String getLast4()

Getter for Last4. The last four digits of a payment card.

Returns:

Returns the String

internalGetCardBrand

protected io.apimatic.core.types.OptionalNullable<String> internalGetCardBrand()

Internal Getter for CardBrand. The brand of the payment card (for example, VISA).

Returns:

Returns the Internal String

getCardBrand

public String getCardBrand()

Getter for CardBrand. The brand of the payment card (for example, VISA).

Returns:

Returns the String

internalGetLimit

protected io.apimatic.core.types.OptionalNullable<Integer> internalGetLimit()

Internal Getter for Limit. The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

Returns the Internal Integer

getLimit

public Integer getLimit()

Getter for Limit. The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page. The default value of 100 is also the maximum allowed value. If the provided value is greater than 100, it is ignored and the default value is used instead. Default: `100`

Returns:

Returns the Integer

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 ListPaymentsRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListPaymentsRequest.Builder toBuilder()

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

Returns:

a new ListPaymentsRequest.Builder object