GiftCardActivity (Square 20.0.0.20220512 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
GiftCardActivity(String type, String locationId, String id, String createdAt, String giftCardId, String giftCardGan, Money giftCardBalanceMoney, GiftCardActivityLoad loadActivityDetails, GiftCardActivityActivate activateActivityDetails, GiftCardActivityRedeem redeemActivityDetails, GiftCardActivityClearBalance clearBalanceActivityDetails, GiftCardActivityDeactivate deactivateActivityDetails, GiftCardActivityAdjustIncrement adjustIncrementActivityDetails, GiftCardActivityAdjustDecrement adjustDecrementActivityDetails, GiftCardActivityRefund refundActivityDetails, GiftCardActivityUnlinkedActivityRefund unlinkedActivityRefundActivityDetails, GiftCardActivityImport importActivityDetails, GiftCardActivityBlock blockActivityDetails, GiftCardActivityUnblock unblockActivityDetails, GiftCardActivityImportReversal importReversalActivityDetails) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`GiftCardActivityActivate`	`getActivateActivityDetails()` Getter for ActivateActivityDetails.
`GiftCardActivityAdjustDecrement`	`getAdjustDecrementActivityDetails()` Getter for AdjustDecrementActivityDetails.
`GiftCardActivityAdjustIncrement`	`getAdjustIncrementActivityDetails()` Getter for AdjustIncrementActivityDetails.
`GiftCardActivityBlock`	`getBlockActivityDetails()` Getter for BlockActivityDetails.
`GiftCardActivityClearBalance`	`getClearBalanceActivityDetails()` Getter for ClearBalanceActivityDetails.
`String`	`getCreatedAt()` Getter for CreatedAt.
`GiftCardActivityDeactivate`	`getDeactivateActivityDetails()` Getter for DeactivateActivityDetails.
`Money`	`getGiftCardBalanceMoney()` Getter for GiftCardBalanceMoney.
`String`	`getGiftCardGan()` Getter for GiftCardGan.
`String`	`getGiftCardId()` Getter for GiftCardId.
`String`	`getId()` Getter for Id.
`GiftCardActivityImport`	`getImportActivityDetails()` Getter for ImportActivityDetails.
`GiftCardActivityImportReversal`	`getImportReversalActivityDetails()` Getter for ImportReversalActivityDetails.
`GiftCardActivityLoad`	`getLoadActivityDetails()` Getter for LoadActivityDetails.
`String`	`getLocationId()` Getter for LocationId.
`GiftCardActivityRedeem`	`getRedeemActivityDetails()` Getter for RedeemActivityDetails.
`GiftCardActivityRefund`	`getRefundActivityDetails()` Getter for RefundActivityDetails.
`String`	`getType()` Getter for Type.
`GiftCardActivityUnblock`	`getUnblockActivityDetails()` Getter for UnblockActivityDetails.
`GiftCardActivityUnlinkedActivityRefund`	`getUnlinkedActivityRefundActivityDetails()` Getter for UnlinkedActivityRefundActivityDetails.
`int`	`hashCode()`
`GiftCardActivity.Builder`	`toBuilder()` Builds a new `GiftCardActivity.Builder` object.
`String`	`toString()` Converts this GiftCardActivity into string format.

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

- Constructor Detail
  - GiftCardActivity
```
public GiftCardActivity(String type,
                        String locationId,
                        String id,
                        String createdAt,
                        String giftCardId,
                        String giftCardGan,
                        Money giftCardBalanceMoney,
                        GiftCardActivityLoad loadActivityDetails,
                        GiftCardActivityActivate activateActivityDetails,
                        GiftCardActivityRedeem redeemActivityDetails,
                        GiftCardActivityClearBalance clearBalanceActivityDetails,
                        GiftCardActivityDeactivate deactivateActivityDetails,
                        GiftCardActivityAdjustIncrement adjustIncrementActivityDetails,
                        GiftCardActivityAdjustDecrement adjustDecrementActivityDetails,
                        GiftCardActivityRefund refundActivityDetails,
                        GiftCardActivityUnlinkedActivityRefund unlinkedActivityRefundActivityDetails,
                        GiftCardActivityImport importActivityDetails,
                        GiftCardActivityBlock blockActivityDetails,
                        GiftCardActivityUnblock unblockActivityDetails,
                        GiftCardActivityImportReversal importReversalActivityDetails)
```
    Initialization constructor.
    
    Parameters:
    
    type - String value for type.
    
    locationId - String value for locationId.
    
    id - String value for id.
    
    createdAt - String value for createdAt.
    
    giftCardId - String value for giftCardId.
    
    giftCardGan - String value for giftCardGan.
    
    giftCardBalanceMoney - Money value for giftCardBalanceMoney.
    
    loadActivityDetails - GiftCardActivityLoad value for loadActivityDetails.
    
    activateActivityDetails - GiftCardActivityActivate value for activateActivityDetails.
    
    redeemActivityDetails - GiftCardActivityRedeem value for redeemActivityDetails.
    
    clearBalanceActivityDetails - GiftCardActivityClearBalance value for clearBalanceActivityDetails.
    
    deactivateActivityDetails - GiftCardActivityDeactivate value for deactivateActivityDetails.
    
    adjustIncrementActivityDetails - GiftCardActivityAdjustIncrement value for adjustIncrementActivityDetails.
    
    adjustDecrementActivityDetails - GiftCardActivityAdjustDecrement value for adjustDecrementActivityDetails.
    
    refundActivityDetails - GiftCardActivityRefund value for refundActivityDetails.
    
    unlinkedActivityRefundActivityDetails - GiftCardActivityUnlinkedActivityRefund value for unlinkedActivityRefundActivityDetails.
    
    importActivityDetails - GiftCardActivityImport value for importActivityDetails.
    
    blockActivityDetails - GiftCardActivityBlock value for blockActivityDetails.
    
    unblockActivityDetails - GiftCardActivityUnblock value for unblockActivityDetails.
    
    importReversalActivityDetails - GiftCardActivityImportReversal value for importReversalActivityDetails.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. The unique ID of the gift card activity.
    
    Returns:
    
    Returns the String
  - getType
```
public String getType()
```
    Getter for Type. Indicates the gift card activity type.
    
    Returns:
    
    Returns the String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The ID of the location at which the activity occurred.
    
    Returns:
    
    Returns the String
  - getCreatedAt
```
public String getCreatedAt()
```
    Getter for CreatedAt. The timestamp when the gift card activity was created, in RFC 3339 format.
    
    Returns:
    
    Returns the String
  - getGiftCardId
```
public String getGiftCardId()
```
    Getter for GiftCardId. The gift card ID. The ID is not required if a GAN is present.
    
    Returns:
    
    Returns the String
  - getGiftCardGan
```
public String getGiftCardGan()
```
    Getter for GiftCardGan. The gift card GAN. The GAN is not required if `gift_card_id` is present.
    
    Returns:
    
    Returns the String
  - getGiftCardBalanceMoney
```
public Money getGiftCardBalanceMoney()
```
    Getter for GiftCardBalanceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getLoadActivityDetails
```
public GiftCardActivityLoad getLoadActivityDetails()
```
    Getter for LoadActivityDetails. Present only when `GiftCardActivityType` is LOAD.
    
    Returns:
    
    Returns the GiftCardActivityLoad
  - getActivateActivityDetails
```
public GiftCardActivityActivate getActivateActivityDetails()
```
    Getter for ActivateActivityDetails. Describes a gift card activity of the ACTIVATE type.
    
    Returns:
    
    Returns the GiftCardActivityActivate
  - getRedeemActivityDetails
```
public GiftCardActivityRedeem getRedeemActivityDetails()
```
    Getter for RedeemActivityDetails. Present only when `GiftCardActivityType` is REDEEM.
    
    Returns:
    
    Returns the GiftCardActivityRedeem
  - getClearBalanceActivityDetails
```
public GiftCardActivityClearBalance getClearBalanceActivityDetails()
```
    Getter for ClearBalanceActivityDetails. Describes a gift card activity of the CLEAR_BALANCE type.
    
    Returns:
    
    Returns the GiftCardActivityClearBalance
  - getDeactivateActivityDetails
```
public GiftCardActivityDeactivate getDeactivateActivityDetails()
```
    Getter for DeactivateActivityDetails. Describes a gift card activity of the DEACTIVATE type.
    
    Returns:
    
    Returns the GiftCardActivityDeactivate
  - getAdjustIncrementActivityDetails
```
public GiftCardActivityAdjustIncrement getAdjustIncrementActivityDetails()
```
    Getter for AdjustIncrementActivityDetails. Describes a gift card activity of the ADJUST_INCREMENT type.
    
    Returns:
    
    Returns the GiftCardActivityAdjustIncrement
  - getAdjustDecrementActivityDetails
```
public GiftCardActivityAdjustDecrement getAdjustDecrementActivityDetails()
```
    Getter for AdjustDecrementActivityDetails. Describes a gift card activity of the ADJUST_DECREMENT type.
    
    Returns:
    
    Returns the GiftCardActivityAdjustDecrement
  - getRefundActivityDetails
```
public GiftCardActivityRefund getRefundActivityDetails()
```
    Getter for RefundActivityDetails. Present only when `GiftCardActivityType` is REFUND.
    
    Returns:
    
    Returns the GiftCardActivityRefund
  - getUnlinkedActivityRefundActivityDetails
```
public GiftCardActivityUnlinkedActivityRefund getUnlinkedActivityRefundActivityDetails()
```
    Getter for UnlinkedActivityRefundActivityDetails. Present only when `GiftCardActivityType` is UNLINKED_ACTIVITY_REFUND.
    
    Returns:
    
    Returns the GiftCardActivityUnlinkedActivityRefund
  - getImportActivityDetails
```
public GiftCardActivityImport getImportActivityDetails()
```
    Getter for ImportActivityDetails. Describes a gift card activity of the IMPORT type and the `GiftCardGANSource` is OTHER (a third-party gift card).
    
    Returns:
    
    Returns the GiftCardActivityImport
  - getBlockActivityDetails
```
public GiftCardActivityBlock getBlockActivityDetails()
```
    Getter for BlockActivityDetails. Describes a gift card activity of the BLOCK type.
    
    Returns:
    
    Returns the GiftCardActivityBlock
  - getUnblockActivityDetails
```
public GiftCardActivityUnblock getUnblockActivityDetails()
```
    Getter for UnblockActivityDetails. Present only when `GiftCardActivityType` is UNBLOCK.
    
    Returns:
    
    Returns the GiftCardActivityUnblock
  - getImportReversalActivityDetails
```
public GiftCardActivityImportReversal getImportReversalActivityDetails()
```
    Getter for ImportReversalActivityDetails. Present only when GiftCardActivityType is IMPORT_REVERSAL and GiftCardGANSource is OTHER
    
    Returns:
    
    Returns the GiftCardActivityImportReversal
  - 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 GiftCardActivity into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public GiftCardActivity.Builder toBuilder()
```
    Builds a new GiftCardActivity.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new GiftCardActivity.Builder object

Class GiftCardActivity

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GiftCardActivity

Method Detail

getId

getType

getLocationId

getCreatedAt

getGiftCardId

getGiftCardGan

getGiftCardBalanceMoney

getLoadActivityDetails

getActivateActivityDetails

getRedeemActivityDetails

getClearBalanceActivityDetails

getDeactivateActivityDetails

getAdjustIncrementActivityDetails

getAdjustDecrementActivityDetails

getRefundActivityDetails

getUnlinkedActivityRefundActivityDetails

getImportActivityDetails

getBlockActivityDetails

getUnblockActivityDetails

getImportReversalActivityDetails

hashCode

equals

toString

toBuilder