GiftCardActivity (Square 37.0.0.20240118 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
Modifier	Constructor and Description
`protected`	GiftCardActivity(String type, String locationId, String id, String createdAt, io.apimatic.core.types.OptionalNullable<String> giftCardId, io.apimatic.core.types.OptionalNullable<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, GiftCardActivityTransferBalanceTo transferBalanceToActivityDetails, GiftCardActivityTransferBalanceFrom transferBalanceFromActivityDetails) Initialization constructor.
	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, GiftCardActivityTransferBalanceTo transferBalanceToActivityDetails, GiftCardActivityTransferBalanceFrom transferBalanceFromActivityDetails) 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.
`GiftCardActivityTransferBalanceFrom`	`getTransferBalanceFromActivityDetails()` Getter for TransferBalanceFromActivityDetails.
`GiftCardActivityTransferBalanceTo`	`getTransferBalanceToActivityDetails()` Getter for TransferBalanceToActivityDetails.
`String`	`getType()` Getter for Type.
`GiftCardActivityUnblock`	`getUnblockActivityDetails()` Getter for UnblockActivityDetails.
`GiftCardActivityUnlinkedActivityRefund`	`getUnlinkedActivityRefundActivityDetails()` Getter for UnlinkedActivityRefundActivityDetails.
`int`	`hashCode()`
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetGiftCardGan()` Internal Getter for GiftCardGan.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetGiftCardId()` Internal Getter for GiftCardId.
`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,
                        GiftCardActivityTransferBalanceTo transferBalanceToActivityDetails,
                        GiftCardActivityTransferBalanceFrom transferBalanceFromActivityDetails)
```
    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.
    
    transferBalanceToActivityDetails - GiftCardActivityTransferBalanceTo value for transferBalanceToActivityDetails.
    
    transferBalanceFromActivityDetails - GiftCardActivityTransferBalanceFrom value for transferBalanceFromActivityDetails.
  - GiftCardActivity
```
protected GiftCardActivity(String type,
                           String locationId,
                           String id,
                           String createdAt,
                           io.apimatic.core.types.OptionalNullable<String> giftCardId,
                           io.apimatic.core.types.OptionalNullable<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,
                           GiftCardActivityTransferBalanceTo transferBalanceToActivityDetails,
                           GiftCardActivityTransferBalanceFrom transferBalanceFromActivityDetails)
```
    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.
    
    transferBalanceToActivityDetails - GiftCardActivityTransferBalanceTo value for transferBalanceToActivityDetails.
    
    transferBalanceFromActivityDetails - GiftCardActivityTransferBalanceFrom value for transferBalanceFromActivityDetails.
- Method Detail
  - getId
```
public String getId()
```
    Getter for Id. The Square-assigned ID of the gift card activity.
    
    Returns:
    
    Returns the String
  - getType
```
public String getType()
```
    Getter for Type. Indicates the type of [gift card activity]($m/GiftCardActivity).
    
    Returns:
    
    Returns the String
  - getLocationId
```
public String getLocationId()
```
    Getter for LocationId. The ID of the [business location](entity:Location) where 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
  - internalGetGiftCardId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetGiftCardId()
```
    Internal Getter for GiftCardId. The gift card ID. When creating a gift card activity, `gift_card_id` is not required if `gift_card_gan` is specified.
    
    Returns:
    
    Returns the Internal String
  - getGiftCardId
```
public String getGiftCardId()
```
    Getter for GiftCardId. The gift card ID. When creating a gift card activity, `gift_card_id` is not required if `gift_card_gan` is specified.
    
    Returns:
    
    Returns the String
  - internalGetGiftCardGan
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetGiftCardGan()
```
    Internal Getter for GiftCardGan. The gift card account number (GAN). When creating a gift card activity, `gift_card_gan` is not required if `gift_card_id` is specified.
    
    Returns:
    
    Returns the Internal String
  - getGiftCardGan
```
public String getGiftCardGan()
```
    Getter for GiftCardGan. The gift card account number (GAN). When creating a gift card activity, `gift_card_gan` is not required if `gift_card_id` is specified.
    
    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. Represents details about a `LOAD` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityLoad
  - getActivateActivityDetails
```
public GiftCardActivityActivate getActivateActivityDetails()
```
    Getter for ActivateActivityDetails. Represents details about an `ACTIVATE` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityActivate
  - getRedeemActivityDetails
```
public GiftCardActivityRedeem getRedeemActivityDetails()
```
    Getter for RedeemActivityDetails. Represents details about a `REDEEM` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityRedeem
  - getClearBalanceActivityDetails
```
public GiftCardActivityClearBalance getClearBalanceActivityDetails()
```
    Getter for ClearBalanceActivityDetails. Represents details about a `CLEAR_BALANCE` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityClearBalance
  - getDeactivateActivityDetails
```
public GiftCardActivityDeactivate getDeactivateActivityDetails()
```
    Getter for DeactivateActivityDetails. Represents details about a `DEACTIVATE` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityDeactivate
  - getAdjustIncrementActivityDetails
```
public GiftCardActivityAdjustIncrement getAdjustIncrementActivityDetails()
```
    Getter for AdjustIncrementActivityDetails. Represents details about an `ADJUST_INCREMENT` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityAdjustIncrement
  - getAdjustDecrementActivityDetails
```
public GiftCardActivityAdjustDecrement getAdjustDecrementActivityDetails()
```
    Getter for AdjustDecrementActivityDetails. Represents details about an `ADJUST_DECREMENT` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityAdjustDecrement
  - getRefundActivityDetails
```
public GiftCardActivityRefund getRefundActivityDetails()
```
    Getter for RefundActivityDetails. Represents details about a `REFUND` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityRefund
  - getUnlinkedActivityRefundActivityDetails
```
public GiftCardActivityUnlinkedActivityRefund getUnlinkedActivityRefundActivityDetails()
```
    Getter for UnlinkedActivityRefundActivityDetails. Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityUnlinkedActivityRefund
  - getImportActivityDetails
```
public GiftCardActivityImport getImportActivityDetails()
```
    Getter for ImportActivityDetails. Represents details about an `IMPORT` [gift card activity type]($m/GiftCardActivityType). This activity type is used when Square imports a third-party gift card, in which case the `gan_source` of the gift card is set to `OTHER`.
    
    Returns:
    
    Returns the GiftCardActivityImport
  - getBlockActivityDetails
```
public GiftCardActivityBlock getBlockActivityDetails()
```
    Getter for BlockActivityDetails. Represents details about a `BLOCK` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityBlock
  - getUnblockActivityDetails
```
public GiftCardActivityUnblock getUnblockActivityDetails()
```
    Getter for UnblockActivityDetails. Represents details about an `UNBLOCK` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityUnblock
  - getImportReversalActivityDetails
```
public GiftCardActivityImportReversal getImportReversalActivityDetails()
```
    Getter for ImportReversalActivityDetails. Represents details about an `IMPORT_REVERSAL` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityImportReversal
  - getTransferBalanceToActivityDetails
```
public GiftCardActivityTransferBalanceTo getTransferBalanceToActivityDetails()
```
    Getter for TransferBalanceToActivityDetails. Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityTransferBalanceTo
  - getTransferBalanceFromActivityDetails
```
public GiftCardActivityTransferBalanceFrom getTransferBalanceFromActivityDetails()
```
    Getter for TransferBalanceFromActivityDetails. Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type]($m/GiftCardActivityType).
    
    Returns:
    
    Returns the GiftCardActivityTransferBalanceFrom
  - 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

GiftCardActivity

Method Detail

getId

getType

getLocationId

getCreatedAt

internalGetGiftCardId

getGiftCardId

internalGetGiftCardGan

getGiftCardGan

getGiftCardBalanceMoney

getLoadActivityDetails

getActivateActivityDetails

getRedeemActivityDetails

getClearBalanceActivityDetails

getDeactivateActivityDetails

getAdjustIncrementActivityDetails

getAdjustDecrementActivityDetails

getRefundActivityDetails

getUnlinkedActivityRefundActivityDetails

getImportActivityDetails

getBlockActivityDetails

getUnblockActivityDetails

getImportReversalActivityDetails

getTransferBalanceToActivityDetails

getTransferBalanceFromActivityDetails

hashCode

equals

toString

toBuilder