Skip to main content

GiftCards

Struct GiftCards 

Source
pub struct GiftCards { /* private fields */ }
Expand description

Gift card operations for issuing, charging, and refunding.

Implementations§

Source§

impl GiftCards

Source

pub fn is_supported(&self) -> bool

Whether gift cards are supported by the active backend.

Source

pub fn create(&self, input: CreateGiftCard) -> Result<GiftCard>

Create a new gift card.

§Example
use stateset_embedded::{Commerce, CreateGiftCard, CustomerId};
use rust_decimal_macros::dec;

let commerce = Commerce::new("./store.db")?;

let gift_card = commerce.gift_cards().create(CreateGiftCard {
    initial_balance: dec!(100.00),
    customer_id: Some(CustomerId::new()),
    ..Default::default()
})?;
Source

pub fn get(&self, id: GiftCardId) -> Result<Option<GiftCard>>

Get a gift card by ID.

Source

pub fn get_by_code(&self, code: &str) -> Result<Option<GiftCard>>

Get a gift card by its unique code.

Source

pub fn update(&self, id: GiftCardId, input: UpdateGiftCard) -> Result<GiftCard>

Update a gift card.

Source

pub fn list(&self, filter: GiftCardFilter) -> Result<Vec<GiftCard>>

List gift cards with optional filtering.

Source

pub fn charge( &self, id: GiftCardId, amount: Decimal, reference_id: Option<String>, ) -> Result<GiftCardTransaction>

Charge (debit) a gift card.

Reduces the gift card balance by the specified amount.

Source

pub fn refund( &self, id: GiftCardId, amount: Decimal, reference_id: Option<String>, ) -> Result<GiftCardTransaction>

Refund (credit) to a gift card.

Increases the gift card balance by the specified amount.

Source

pub fn disable(&self, id: GiftCardId) -> Result<GiftCard>

Disable a gift card so it can no longer be used.

Source

pub fn get_transactions( &self, gift_card_id: GiftCardId, ) -> Result<Vec<GiftCardTransaction>>

Get transaction history for a gift card.

Trait Implementations§

Source§

impl Debug for GiftCards

Source§

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

Formats the value using the given formatter. Read more

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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