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

//! Resource Function Module

use serde::{Deserialize, Serialize};

use crate::common::note::Note;
use crate::common::related_party::RelatedParty;
use crate::common::tmf_error::TMFError;
use crate::{
    DateTime, HasDescription, HasId, HasName, HasNote, HasRelatedParty, HasValidity, Priority,
    TimePeriod, Uri,
};
use tmflib_derive::{HasDescription, HasId, HasName, HasNote, HasRelatedParty, HasValidity};

use super::MOD_PATH;

const CLASS_PATH: &str = "resourceFunction";

/// Reference to Resource Function
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct ResourceFunctionRef {
    /// Referenced Uri
    pub href: Uri,
    /// Referenced Id
    pub id: String,
    /// Referenced Name
    pub name: String,
    /// Referenced Version
    pub version: String,
}

impl From<ResourceFunction> for ResourceFunctionRef {
    fn from(value: ResourceFunction) -> Self {
        ResourceFunctionRef {
            href: value.get_href(),
            id: value.get_id(),
            name: value.get_name(),
            version: value.resource_version.unwrap_or("1.0".to_string()),
        }
    }
}

/// Administrative Status
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub enum ResourceAdministrativeStateType {
    /// Resource is Locked
    Locked,
    /// Resource is unlocked
    #[default]
    Unlocked,
    /// Resource is shutdown
    Shutdown,
}

/// Operational Status
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub enum ResourceOperationalStateType {
    /// Resource is enabled
    Enable,
    /// Resource is disabled
    #[default]
    Disable,
}

/// Usage Status
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub enum ResourceUsageStateType {
    /// Function is idle
    Idle,
    /// Function is busy
    Busy,
    /// Function is active
    #[default]
    Active,
}

/// Configuration Feature
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct Feature {
    // Referenced objects
    /// Relationships
    pub feature_relationship: Option<Vec<FeatureRelationship>>,
}

/// Feature Relationship
#[derive(Clone, Debug, Default, Deserialize, HasId, HasName, HasValidity, Serialize)]
pub struct FeatureRelationship {
    id: Option<String>,
    href: Option<Uri>,
    name: Option<String>,
    relationship_type: Option<String>,
    valid_for: Option<TimePeriod>,
}

/// # Resource Function
/// A ResourceFunction is a behaviour to transform inputs of any nature into outputs of any
/// nature independently from the way it is provided.
#[derive(
    Clone,
    Debug,
    Default,
    HasId,
    HasName,
    HasDescription,
    HasRelatedParty,
    HasNote,
    Deserialize,
    Serialize,
)]
pub struct ResourceFunction {
    /// Administrative Status
    pub administrative_state: Option<ResourceAdministrativeStateType>,
    /// Category of the concrete resource. e.g. Gold, Silver for MSISDN concrete resource.
    pub category: Option<String>,
    /// The date till the resource is operating.
    pub end_operating_date: Option<DateTime>,
    /// A type of the Resource Function as specified by the provider of the API.
    pub function_type: Option<String>,
    /// Operational Status
    pub operational_state: Option<ResourceOperationalStateType>,
    /// Function Priority
    pub priority: Option<Priority>,
    /// Unique Id
    pub id: Option<String>,
    /// HTTP Uri
    pub href: Option<Uri>,
    /// Name
    pub name: Option<String>,
    /// Description
    pub description: Option<String>,
    /// Version of resource
    pub resource_version: Option<String>,
    /// Function Role
    pub role: Option<String>,
    /// Operational Start Date
    pub start_operating_date: Option<DateTime>,
    /// Usage Status
    pub usage_state: Option<ResourceUsageStateType>,
    /// The value of the logical resource. e.g. '07439823498' for MSISDNs
    pub value: Option<String>,
    // Reference Modules
    /// Related Parties
    pub related_party: Option<Vec<RelatedParty>>,
    /// Activation Feature
    pub activation_feature: Option<Vec<Feature>>,
    /// Notes
    pub note: Option<Vec<Note>>,
}