tmflib 0.1.37

Interface library for processing TMF payloads
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172

//! Sales Lead Module
//!
use crate::common::contact::ContactMedium;
use crate::common::money::Money;
use crate::common::note::Note;
use crate::common::related_party::RelatedParty;
use crate::common::tmf_error::TMFError;

use crate::tmf620::category::CategoryRef;
#[cfg(feature = "build-V4")]
use crate::tmf620::product_offering::ProductOfferingRef;
#[cfg(feature = "build-V5")]
use crate::tmf620::product_offering_v5::ProductOfferingRef;
use crate::tmf620::product_specification::ProductSpecificationRef;
use crate::tmf620::{ChannelRef, MarketSegmentRef};

use super::MOD_PATH;
use crate::{DateTime, HasId, HasName, HasNote, HasValidity, TimePeriod, Uri};
use tmflib_derive::{HasId, HasName, HasNote, HasValidity};

use serde::{Deserialize, Serialize};

const CLASS_PATH: &str = "salesLead";
const LEAD_VALID: u64 = 30;

/// Sales Lead Priorities
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum SalesLeadPrioityType {
    /// Low Priority
    Low,
    #[default]
    /// Medium Priority (default)
    Medium,
    /// High Priority
    High,
}

/// Sales Lead Status
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub enum SalesLeadStateType {
    /// Accepted (default)
    #[default]
    Accepted,
    /// Acknowledged
    Acknowledged,
    /// Cancelled
    Cancelled,
    /// In Progress
    InProgress,
    /// Pending
    Pending,
    /// Rejected
    Rejected,
}

/// Sales Lead - for tracking potential sales.
#[derive(Clone, Debug, Default, Deserialize, HasId, HasValidity, HasNote, HasName, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SalesLead {
    #[serde(skip_serializing_if = "Option::is_none")]
    id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    href: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    creation_date: Option<DateTime>,
    #[serde(skip_serializing_if = "Option::is_none")]
    description: Option<String>,
    name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    rating: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    referred_date: Option<DateTime>,
    #[serde(skip_serializing_if = "Option::is_none")]
    status_change_date: Option<DateTime>,
    #[serde(skip_serializing_if = "Option::is_none")]
    status_change_reason: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    r#type: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    estimated_revenue: Option<Money>,
    #[serde(skip_serializing_if = "Option::is_none")]
    priority: Option<SalesLeadPrioityType>,
    status: Option<SalesLeadStateType>,
    #[serde(skip_serializing_if = "Option::is_none")]
    valid_for: Option<TimePeriod>,
    #[serde(skip_serializing_if = "Option::is_none")]
    prospect_contact: Option<Vec<ContactMedium>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    category: Option<CategoryRef>,
    #[serde(skip_serializing_if = "Option::is_none")]
    channel: Option<ChannelRef>,
    #[serde(skip_serializing_if = "Option::is_none")]
    market_segment: Option<MarketSegmentRef>,
    #[serde(skip_serializing_if = "Option::is_none")]
    note: Option<Vec<Note>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    product_offering: Option<ProductOfferingRef>,
    #[serde(skip_serializing_if = "Option::is_none")]
    product_specification: Option<ProductSpecificationRef>,
    #[serde(skip_serializing_if = "Option::is_none")]
    related_party: Option<Vec<RelatedParty>>,
}

impl SalesLead {
    /// Create a new sales lead under a given names
    pub fn new(name: impl Into<String>) -> SalesLead {
        let mut sl = SalesLead::create();
        sl.name = Some(name.into());
        sl.status = Some(SalesLeadStateType::default());
        sl.priority = Some(SalesLeadPrioityType::default());
        sl.valid_for = Some(TimePeriod::period_days(LEAD_VALID));
        sl
    }
}

/// Sales Lead Reference
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SalesLeadRef {
    href: Uri,
    id: String,
    name: String,
}

impl From<SalesLead> for SalesLeadRef {
    fn from(value: SalesLead) -> Self {
        SalesLeadRef {
            href: value.get_href(),
            id: value.get_id(),
            name: value.get_name(),
        }
    }
}

#[cfg(test)]
mod test {
    use super::SalesLead;
    use super::{HasId, HasName};
    const SL_NAME: &str = "My Sales Lead";
    #[test]
    fn sales_lead_create_id() {
        // Generate shipping order, test id
        let sl = SalesLead::new(SL_NAME);

        assert_eq!(sl.id.is_some(), true);
    }

    #[test]
    fn sales_lead_create_href() {
        let sl = SalesLead::new(SL_NAME);

        assert_eq!(sl.href.is_some(), true);
    }

    #[test]
    fn sales_lead_create_href_matches_id() {
        let sl = SalesLead::new(SL_NAME);
        let id = sl.get_id();
        let href = sl.get_href();

        assert!(href.contains(&id));
    }

    #[test]
    fn sales_lead_create_name() {
        let sl = SalesLead::new(SL_NAME);

        assert_eq!(sl.get_name(), SL_NAME.to_string());
    }
}