com.squareup.square.models

Class ListPaymentRefundsRequest

java.lang.Object

com.squareup.square.models.ListPaymentRefundsRequest

public class ListPaymentRefundsRequest
extends Object

This is a model class for ListPaymentRefundsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListPaymentRefundsRequest(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<String> status, io.apimatic.core.types.OptionalNullable<String> sourceType, io.apimatic.core.types.OptionalNullable<Integer> limit) Initialization constructor.
	ListPaymentRefundsRequest(String beginTime, String endTime, String sortOrder, String cursor, String locationId, String status, String sourceType, Integer limit) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getBeginTime() Getter for BeginTime.
String	getCursor() Getter for Cursor.
String	getEndTime() Getter for EndTime.
Integer	getLimit() Getter for Limit.
String	getLocationId() Getter for LocationId.
String	getSortOrder() Getter for SortOrder.
String	getSourceType() Getter for SourceType.
String	getStatus() Getter for Status.
int	hashCode()
protected io.apimatic.core.types.OptionalNullable<String>	internalGetBeginTime() Internal Getter for BeginTime.
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<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<String>	internalGetSourceType() Internal Getter for SourceType.
protected io.apimatic.core.types.OptionalNullable<String>	internalGetStatus() Internal Getter for Status.
ListPaymentRefundsRequest.Builder	toBuilder() Builds a new ListPaymentRefundsRequest.Builder object.
String	toString() Converts this ListPaymentRefundsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPaymentRefundsRequest

public ListPaymentRefundsRequest(String beginTime,
                                 String endTime,
                                 String sortOrder,
                                 String cursor,
                                 String locationId,
                                 String status,
                                 String sourceType,
                                 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.

status - String value for status.

sourceType - String value for sourceType.

limit - Integer value for limit.

ListPaymentRefundsRequest

protected ListPaymentRefundsRequest(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<String> status,
                                    io.apimatic.core.types.OptionalNullable<String> sourceType,
                                    io.apimatic.core.types.OptionalNullable<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.

status - String value for status.

sourceType - String value for sourceType.

limit - Integer value for limit.

Method Detail

internalGetBeginTime

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

Internal Getter for BeginTime. Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339 format. The range is determined using the `created_at` field for each `PaymentRefund`. 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 each `PaymentRefund` for, in RFC 3339 format. The range is determined using the `created_at` field for each `PaymentRefund`. 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 each `PaymentRefund` for, in RFC 3339 format. The range is determined using the `created_at` field for each `PaymentRefund`. 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 each `PaymentRefund` for, in RFC 3339 format. The range is determined using the `created_at` field for each `PaymentRefund`. 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 `PaymentRefund.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 `PaymentRefund.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 all locations 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 all locations associated with the seller.

Returns:

Returns the String

internalGetStatus

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

Internal Getter for Status. If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund](entity:PaymentRefund). Default: If omitted, refunds are returned regardless of their status.

Returns:

Returns the Internal String

getStatus

public String getStatus()

Getter for Status. If provided, only refunds with the given status are returned. For a list of refund status values, see [PaymentRefund](entity:PaymentRefund). Default: If omitted, refunds are returned regardless of their status.

Returns:

Returns the String

internalGetSourceType

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

Internal Getter for SourceType. If provided, only returns refunds whose payments have the indicated source type. Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. For information about these payment source types, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). Default: If omitted, refunds are returned regardless of the source type.

Returns:

Returns the Internal String

getSourceType

public String getSourceType()

Getter for SourceType. If provided, only returns refunds whose payments have the indicated source type. Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`. For information about these payment source types, see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments). Default: If omitted, refunds are returned regardless of the source type.

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. If the supplied value is greater than 100, no more than 100 results are returned. 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. If the supplied value is greater than 100, no more than 100 results are returned. 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 ListPaymentRefundsRequest into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListPaymentRefundsRequest.Builder toBuilder()

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

Returns:

a new ListPaymentRefundsRequest.Builder object