GiftCardActivity class
Constructors
GiftCardActivity ({required GiftCardActivityType type , required String locationId , String ? id , DateTime ? 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 })
const
GiftCardActivity.fromJson (Map <String , dynamic > json )
Converts a Map <String , dynamic
> to a GiftCardActivity
factory
Properties
activateActivityDetails
→ GiftCardActivityActivate ?
Additional details about an ACTIVATE
activity, which is used to
activate a gift card with an initial balance.
final
adjustDecrementActivityDetails
→ GiftCardActivityAdjustDecrement ?
Additional details about an ADJUST_DECREMENT
activity, which is used
to deduct money from a gift card outside of a typical REDEEM
activity
flow.
final
adjustIncrementActivityDetails
→ GiftCardActivityAdjustIncrement ?
Additional details about an ADJUST_INCREMENT
activity, which is used
to add money to a gift card outside of a typical ACTIVATE
, LOAD
, or
REFUND
activity flow.
final
blockActivityDetails
→ GiftCardActivityBlock ?
Read only Additional details about a BLOCK
activity, which Square
uses to temporarily block a gift card.
final
clearBalanceActivityDetails
→ GiftCardActivityClearBalance ?
Additional details about a CLEAR_BALANCE
activity, which is used to set
the balance of a gift card to zero.
final
createdAt
→ DateTime ?
Read only The timestamp when the gift card activity was created,
in RFC 3339 format.
final
deactivateActivityDetails
→ GiftCardActivityDeactivate ?
Additional details about a DEACTIVATE
activity, which is used to
deactivate a gift card.
final
giftCardBalanceMoney
→ Money ?
Read only The final balance on the gift card after the action
is completed.
final
giftCardGan
→ String ?
The gift card account number (GAN). When creating a gift card activity,
gift_card_gan
is not required if gift_card_id
is specified.
final
giftCardId
→ String ?
The gift card ID. When creating a gift card activity, gift_card_id
is
not required if gift_card_gan
is specified.
final
hashCode
→ int
The hash code for this object.
no setter inherited
id
→ String ?
Read only The Square-assigned ID of the gift card activity.
final
importActivityDetails
→ GiftCardActivityImport ?
Read only Additional details about an IMPORT
activity, which Square
uses to import a third-party gift card with a balance.
final
importReversalActivityDetails
→ GiftCardActivityImportReversal ?
Read only Additional details about an IMPORT_REVERSAL
activity,
which Square uses to reverse the import of a third-party gift card.
final
loadActivityDetails
→ GiftCardActivityLoad ?
Additional details about a LOAD
activity, which is used to reload
money onto a gift card.
final
locationId
→ String
The ID of the business location where the activity occurred.
final
props
→ List <Object ? >
The list of properties that will be used to determine whether
two instances are equal.
no setter
redeemActivityDetails
→ GiftCardActivityRedeem ?
Additional details about a REDEEM
activity, which is used to redeem a
gift card for a purchase.
final
refundActivityDetails
→ GiftCardActivityRefund ?
Additional details about a REFUND
activity, which is used to add money
to a gift card when refunding a payment.
final
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
stringify
→ bool ?
If set to true
, the toString method will be overridden to output
this instance's props .
no setter inherited
type
→ GiftCardActivityType
The type of gift card activity.
final
unblockActivityDetails
→ GiftCardActivityUnblock ?
Read only Additional details about an UNBLOCK
activity, which
Square uses to unblock a gift card.
final
unlinkedActivityRefundActivityDetails
→ GiftCardActivityUnlinkedActivityRefund ?
Additional details about an UNLINKED_ACTIVITY_REFUND
activity. This
activity is used to add money to a gift card when refunding a payment
that was processed using a custom payment processing system and not
linked to the gift card.
final