com.squareup.square.models

Class ListPayoutsRequest

java.lang.Object

com.squareup.square.models.ListPayoutsRequest

public class ListPayoutsRequest
extends Object

This is a model class for ListPayoutsRequest type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListPayoutsRequest(io.apimatic.core.types.OptionalNullable<String> locationId, String status, io.apimatic.core.types.OptionalNullable<String> beginTime, io.apimatic.core.types.OptionalNullable<String> endTime, String sortOrder, io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<Integer> limit) Internal initialization constructor.
	ListPayoutsRequest(String locationId, String status, String beginTime, String endTime, String sortOrder, String cursor, 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	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.
ListPayoutsRequest.Builder	toBuilder() Builds a new ListPayoutsRequest.Builder object.
String	toString() Converts this ListPayoutsRequest into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPayoutsRequest

public ListPayoutsRequest(String locationId,
                          String status,
                          String beginTime,
                          String endTime,
                          String sortOrder,
                          String cursor,
                          Integer limit)

Initialization constructor.

Parameters:

locationId - String value for locationId.

status - String value for status.

beginTime - String value for beginTime.

endTime - String value for endTime.

sortOrder - String value for sortOrder.

cursor - String value for cursor.

limit - Integer value for limit.

ListPayoutsRequest

protected ListPayoutsRequest(io.apimatic.core.types.OptionalNullable<String> locationId,
                             String status,
                             io.apimatic.core.types.OptionalNullable<String> beginTime,
                             io.apimatic.core.types.OptionalNullable<String> endTime,
                             String sortOrder,
                             io.apimatic.core.types.OptionalNullable<String> cursor,
                             io.apimatic.core.types.OptionalNullable<Integer> limit)

Internal initialization constructor.

Method Detail

internalGetLocationId

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

Internal Getter for LocationId. The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.

Returns:

Returns the Internal String

getLocationId

public String getLocationId()

Getter for LocationId. The ID of the location for which to list the payouts. By default, payouts are returned for the default (main) location associated with the seller.

Returns:

Returns the String

getStatus

public String getStatus()

Getter for Status. Payout status types

Returns:

Returns the String

internalGetBeginTime

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

Internal Getter for BeginTime. The timestamp for the beginning of the payout creation time, in RFC 3339 format. Inclusive. Default: The current time minus one year.

Returns:

Returns the Internal String

getBeginTime

public String getBeginTime()

Getter for BeginTime. The timestamp for the beginning of the payout creation time, in RFC 3339 format. 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. The timestamp for the end of the payout creation time, in RFC 3339 format. Default: The current time.

Returns:

Returns the Internal String

getEndTime

public String getEndTime()

Getter for EndTime. The timestamp for the end of the payout creation time, in RFC 3339 format. Default: The current time.

Returns:

Returns the String

getSortOrder

public String getSortOrder()

Getter for SortOrder. The order (e.g., chronological or alphabetical) in which results from a request are returned.

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). If request parameters change between requests, subsequent results may contain duplicates or missing records.

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). If request parameters change between requests, subsequent results may contain duplicates or missing records.

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

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public ListPayoutsRequest.Builder toBuilder()

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

Returns:

a new ListPayoutsRequest.Builder object