promotion_kit 0.1.1

A powerful Rust toolkit for managing dynamic promotions with flexible rules and seamless integration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

/// Type of discount being applied.
#[derive(Debug, Clone, PartialEq)]
pub enum DiscountType {
    /// Percentage-based discount, e.g. 10.0 = 10%
    Percentage(f64),

    /// Fixed amount discount, e.g. 5000 = 5000 units of currency
    FixedAmount(f64),
}

/// Target category where the promotion can be applied.
///
/// Users of the library can define their own categories (e.g. "product", "service", etc.)
#[derive(Debug, Clone, PartialEq)]
pub enum TargetScope {
    /// Promotion is applicable to any item or category
    Global,

    /// Promotion is restricted to a specific label, tag, or category
    Specific(String),
}

/// Represents a generic promotion or discount campaign.
#[derive(Debug, Clone)]
pub struct Promotion {
    /// Unique code used to apply the promotion
    pub code: String,

    /// Human-readable description
    pub description: String,

    /// Discount mechanics
    pub discount: DiscountType,

    /// Optional maximum number of times the promo can be used
    pub usage_limit: Option<u32>,

    /// Current number of times the promo has been used
    pub used: u32,

    /// Validity start time (epoch seconds)
    pub valid_from: u64,

    /// Validity end time (epoch seconds)
    pub valid_until: u64,

    /// Minimum required transaction value to apply the promo
    pub min_transaction: Option<f64>,

    /// Category or scope where this promo is valid
    pub target: TargetScope,

    /// The currency used for the promotion (e.g., "USD", "EUR")
    /// This field could be optional or have a default currency.
    pub currency: Option<String>,
}