ListGiftCardActivitiesRequest (Square 37.0.0.20240118 API)

java.lang.Object
- com.squareup.square.models.ListGiftCardActivitiesRequest

```
public class ListGiftCardActivitiesRequest
extends Object
```
This is a model class for ListGiftCardActivitiesRequest type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ListGiftCardActivitiesRequest.Builder
Class to build instances of ListGiftCardActivitiesRequest.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ListGiftCardActivitiesRequest.Builder` Class to build instances of `ListGiftCardActivitiesRequest`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ListGiftCardActivitiesRequest(io.apimatic.core.types.OptionalNullable<String> giftCardId, io.apimatic.core.types.OptionalNullable<String> type, io.apimatic.core.types.OptionalNullable<String> locationId, io.apimatic.core.types.OptionalNullable<String> beginTime, io.apimatic.core.types.OptionalNullable<String> endTime, io.apimatic.core.types.OptionalNullable<Integer> limit, io.apimatic.core.types.OptionalNullable<String> cursor, io.apimatic.core.types.OptionalNullable<String> sortOrder)` Initialization constructor.
	`ListGiftCardActivitiesRequest(String giftCardId, String type, String locationId, String beginTime, String endTime, Integer limit, String cursor, String sortOrder)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`String`	`getGiftCardId()` Getter for GiftCardId.
`Integer`	`getLimit()` Getter for Limit.
`String`	`getLocationId()` Getter for LocationId.
`String`	`getSortOrder()` Getter for SortOrder.
`String`	`getType()` Getter for Type.
`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<String>`	`internalGetGiftCardId()` Internal Getter for GiftCardId.
`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>`	`internalGetType()` Internal Getter for Type.
`ListGiftCardActivitiesRequest.Builder`	`toBuilder()` Builds a new `ListGiftCardActivitiesRequest.Builder` object.
`String`	`toString()` Converts this ListGiftCardActivitiesRequest into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ListGiftCardActivitiesRequest
```
public ListGiftCardActivitiesRequest(String giftCardId,
                                     String type,
                                     String locationId,
                                     String beginTime,
                                     String endTime,
                                     Integer limit,
                                     String cursor,
                                     String sortOrder)
```
    Initialization constructor.
    
    Parameters:
    
    giftCardId - String value for giftCardId.
    
    type - String value for type.
    
    locationId - String value for locationId.
    
    beginTime - String value for beginTime.
    
    endTime - String value for endTime.
    
    limit - Integer value for limit.
    
    cursor - String value for cursor.
    
    sortOrder - String value for sortOrder.
  - ListGiftCardActivitiesRequest
```
protected ListGiftCardActivitiesRequest(io.apimatic.core.types.OptionalNullable<String> giftCardId,
                                        io.apimatic.core.types.OptionalNullable<String> type,
                                        io.apimatic.core.types.OptionalNullable<String> locationId,
                                        io.apimatic.core.types.OptionalNullable<String> beginTime,
                                        io.apimatic.core.types.OptionalNullable<String> endTime,
                                        io.apimatic.core.types.OptionalNullable<Integer> limit,
                                        io.apimatic.core.types.OptionalNullable<String> cursor,
                                        io.apimatic.core.types.OptionalNullable<String> sortOrder)
```
    Initialization constructor.
    
    Parameters:
    
    giftCardId - String value for giftCardId.
    
    type - String value for type.
    
    locationId - String value for locationId.
    
    beginTime - String value for beginTime.
    
    endTime - String value for endTime.
    
    limit - Integer value for limit.
    
    cursor - String value for cursor.
    
    sortOrder - String value for sortOrder.
- Method Detail
  - internalGetGiftCardId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetGiftCardId()
```
    Internal Getter for GiftCardId. If a gift card ID is provided, the endpoint returns activities related to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.
    
    Returns:
    
    Returns the Internal String
  - getGiftCardId
```
public String getGiftCardId()
```
    Getter for GiftCardId. If a gift card ID is provided, the endpoint returns activities related to the specified gift card. Otherwise, the endpoint returns all gift card activities for the seller.
    
    Returns:
    
    Returns the String
  - internalGetType
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetType()
```
    Internal Getter for Type. If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. Otherwise, the endpoint returns all types of gift card activities.
    
    Returns:
    
    Returns the Internal String
  - getType
```
public String getType()
```
    Getter for Type. If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. Otherwise, the endpoint returns all types of gift card activities.
    
    Returns:
    
    Returns the String
  - internalGetLocationId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetLocationId()
```
    Internal Getter for LocationId. If a location ID is provided, the endpoint returns gift card activities for the specified location. Otherwise, the endpoint returns gift card activities for all locations.
    
    Returns:
    
    Returns the Internal String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. If a location ID is provided, the endpoint returns gift card activities for the specified location. Otherwise, the endpoint returns gift card activities for all locations.
    
    Returns:
    
    Returns the String
  - internalGetBeginTime
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetBeginTime()
```
    Internal Getter for BeginTime. The timestamp for the beginning of the reporting period, in RFC 3339 format. This start time is inclusive. The default value is 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 reporting period, in RFC 3339 format. This start time is inclusive. The default value is 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 reporting period, in RFC 3339 format. This end time is inclusive. The default value is the current time.
    
    Returns:
    
    Returns the Internal String
  - getEndTime
```
public String getEndTime()
```
    Getter for EndTime. The timestamp for the end of the reporting period, in RFC 3339 format. This end time is inclusive. The default value is the current time.
    
    Returns:
    
    Returns the String
  - internalGetLimit
```
protected io.apimatic.core.types.OptionalNullable<Integer> internalGetLimit()
```
    Internal Getter for Limit. If a limit is provided, the endpoint returns the specified number of results (or fewer) per page. The maximum value is 100. The default value is 50. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
    
    Returns:
    
    Returns the Internal Integer
  - getLimit
```
public Integer getLimit()
```
    Getter for Limit. If a limit is provided, the endpoint returns the specified number of results (or fewer) per page. The maximum value is 100. The default value is 50. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
    
    Returns:
    
    Returns the Integer
  - 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. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/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. If a cursor is not provided, the endpoint returns the first page of the results. For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
    
    Returns:
    
    Returns the String
  - internalGetSortOrder
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetSortOrder()
```
    Internal Getter for SortOrder. The order in which the endpoint returns the activities, based on `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 the endpoint returns the activities, based on `created_at`. - `ASC` - Oldest to newest. - `DESC` - Newest to oldest (default).
    
    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 ListGiftCardActivitiesRequest into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public ListGiftCardActivitiesRequest.Builder toBuilder()
```
    Builds a new ListGiftCardActivitiesRequest.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new ListGiftCardActivitiesRequest.Builder object

Class ListGiftCardActivitiesRequest

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ListGiftCardActivitiesRequest

ListGiftCardActivitiesRequest

Method Detail

internalGetGiftCardId

getGiftCardId

internalGetType

getType

internalGetLocationId

getLocationId

internalGetBeginTime

getBeginTime

internalGetEndTime

getEndTime

internalGetLimit

getLimit

internalGetCursor

getCursor

internalGetSortOrder

getSortOrder

hashCode

equals

toString

toBuilder