square_api_client/models/enums/gift_card_activity_redeem_status.rs
1//! Model for GiftCardActivityRedeemStatus enum
2
3use serde::{Deserialize, Serialize};
4
5/// Indicates the status of a [gift card](GiftCard) redemption.
6///
7/// This status is relevant only for redemptions made from Square products (such as Square Point of
8/// Sale) because Square products use a two-state process. Gift cards redeemed using the Gift Card
9/// Activities API always have a `COMPLETED` status.
10#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
11#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
12pub enum GiftCardActivityRedeemStatus {
13 /// The gift card redemption is pending. `PENDING` is a temporary status that applies when a
14 /// gift card is redeemed from Square Point of Sale or another Square product. A `PENDING`
15 /// status is updated to `COMPLETED` if the payment is captured or `CANCELED` if the
16 /// authorization is voided.
17 Pending,
18 /// The gift card redemption is completed.
19 Completed,
20 /// The gift card redemption is canceled. A redemption is canceled if the authorization on the
21 /// gift card is voided.
22 Canceled,
23}