Struct GiftCardActivity

Source
pub struct GiftCardActivity {
Show 20 fields 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>,
}
Expand description

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§

Source§

impl Clone for GiftCardActivity

Source§

fn clone(&self) -> GiftCardActivity

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GiftCardActivity

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GiftCardActivity

Source§

fn default() -> GiftCardActivity

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for GiftCardActivity

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for GiftCardActivity

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for GiftCardActivity

Source§

impl StructuralPartialEq for GiftCardActivity

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,