Struct square_api_client::models::GiftCardActivity

pub struct GiftCardActivity {

    pub id: Option<String>,
    pub location_id: String,
    pub type: GiftCardActivityType,
    pub activate_activity_details: Option<GiftCardActivityActivate>,
    pub adjust_decrement_activity_details: Option<GiftCardActivityAdjustDecrement>,
    pub adjust_increment_activity_details: Option<GiftCardActivityAdjustIncrement>,
    pub block_activity_details: Option<GiftCardActivityBlock>,
    pub clear_balance_activity_details: Option<GiftCardActivityClearBalance>,
    pub created_at: Option<DateTime>,
    pub deactivate_activity_details: Option<GiftCardActivityDeactivate>,
    pub gift_card_balance_money: Option<Money>,
    pub gift_card_gan: Option<String>,
    pub gift_card_id: Option<String>,
    pub import_activity_details: Option<GiftCardActivityImport>,
    pub import_reversal_activity_details: Option<GiftCardActivityImportReversal>,
    pub load_activity_details: Option<GiftCardActivityLoad>,
    pub redeem_activity_details: Option<GiftCardActivityRedeem>,
    pub refund_activity_details: Option<GiftCardActivityRefund>,
    pub unblock_activity_details: Option<GiftCardActivityUnblock>,
    pub unlinked_activity_refund_activity_details: Option<GiftCardActivityUnlinkedActivityRefund>,
}

Represents an action performed on a gift card that affects its state or balance.

A gift card activity contains information about a specific activity type. For example, a REDEEM activity includes a redeem_activity_details field that contains information about the redemption.

Fields

id: Option<String>

Read only The Square-assigned ID of the gift card activity.

location_id: String

The ID of the business location where the activity occurred.

type: GiftCardActivityType

The type of gift card activity.

activate_activity_details: Option<GiftCardActivityActivate>

Additional details about an ACTIVATE activity, which is used to activate a gift card with an initial balance.

adjust_decrement_activity_details: Option<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.

adjust_increment_activity_details: Option<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.

block_activity_details: Option<GiftCardActivityBlock>

Read only Additional details about a BLOCK activity, which Square uses to temporarily block a gift card.

clear_balance_activity_details: Option<GiftCardActivityClearBalance>

Additional details about a CLEAR_BALANCE activity, which is used to set the balance of a gift card to zero.

created_at: Option<DateTime>

Read only The timestamp when the gift card activity was created, in RFC 3339 format.

deactivate_activity_details: Option<GiftCardActivityDeactivate>

Additional details about a DEACTIVATE activity, which is used to deactivate a gift card.

gift_card_balance_money: Option<Money>

Read only The final balance on the gift card after the action is completed.

gift_card_gan: Option<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.

gift_card_id: Option<String>

The gift card ID. When creating a gift card activity, gift_card_id is not required if gift_card_gan is specified.

import_activity_details: Option<GiftCardActivityImport>

Read only Additional details about an IMPORT activity, which Square uses to import a third-party gift card with a balance.

import_reversal_activity_details: Option<GiftCardActivityImportReversal>

Read only Additional details about an IMPORT_REVERSAL activity, which Square uses to reverse the import of a third-party gift card.

load_activity_details: Option<GiftCardActivityLoad>

Additional details about a LOAD activity, which is used to reload money onto a gift card.

redeem_activity_details: Option<GiftCardActivityRedeem>

Additional details about a REDEEM activity, which is used to redeem a gift card for a purchase.

For applications that process payments using the Square Payments API, Square creates a REDEEM activity that updates the gift card balance after the corresponding CreatePayment request is completed. Applications that use a custom payment processing system must call CreateGiftCardActivity to create the REDEEM activity.

refund_activity_details: Option<GiftCardActivityRefund>

Additional details about a REFUND activity, which is used to add money to a gift card when refunding a payment.

For applications that process payments using the Square Payments API, Square creates a REFUND activity that updates the gift card balance after the corresponding RefundPayment request is completed. Applications that use a custom payment processing system must call CreateGiftCardActivity to create the REFUND activity.

unblock_activity_details: Option<GiftCardActivityUnblock>

Read only Additional details about an UNBLOCK activity, which Square uses to unblock a gift card.

unlinked_activity_refund_activity_details: Option<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.

Trait Implementations

impl Clone for GiftCardActivity

fn clone(&self) -> GiftCardActivity

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GiftCardActivity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GiftCardActivity

fn default() -> GiftCardActivity

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GiftCardActivity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<GiftCardActivity> for GiftCardActivity

fn eq(&self, other: &GiftCardActivity) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GiftCardActivity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for GiftCardActivity

impl StructuralEq for GiftCardActivity

impl StructuralPartialEq for GiftCardActivity