tmflib 0.1.40

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

// Copyright [2026] [Ryan Ruckley]

// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at

//     http://www.apache.org/licenses/LICENSE-2.0

// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! TMF727 - Service Usage Module

use super::{
    Characteristic, ExternalIdentifier, RelatedPartyRefOrPartyRoleRef, ResourceUsageRef,
    ServiceRef, ServiceUsageRef, ServiceUsageSpecificationRef,
};
use crate::common::entity::Entity;
use crate::HasId;
use crate::IsAddressable;
use serde::{Deserialize, Serialize};

use super::MOD_PATH;
use tmflib_derive::HasId;

/// Path to module
pub const CLASS_PATH: &str = "serviceUsage";

///Service Usage represents the actual usage of a service by a customer or other party. It is used to track the usage of a service in a specific context, e.g. for a specific customer or in a specific environment.
#[derive(Debug, Clone, Serialize, Deserialize, Default, HasId)]
pub struct ServiceUsage {
    ///Unique identifier for this service usage
    pub id: Option<String>,
    ///Unique identifier for this service usage
    pub href: Option<String>,
    ///Base entity schema for use in `TMForum` Open-APIs. Property.
    #[serde(flatten)]
    pub entity: Entity,
    ///Relationship to Service Usage in bundle
    #[serde(rename = "bundledServiceUsage")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub bundled_service_usage: Vec<ServiceUsageRef>,
    ///Description of service usage
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    ///A list of external identifiers assoicated with this service
    #[serde(rename = "externalIdentifier")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub external_identifier: Vec<ExternalIdentifier>,
    ///isBundle determines whether usage represents a single usage (false), or a bundle of usages specifications (true).
    #[serde(rename = "isBundle")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub is_bundle: Option<bool>,
    ///A list of related party references (`RelatedParty` [*]). A related party defines party or party role linked to a specific entity
    #[serde(rename = "relatedParty")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub related_party: Vec<RelatedPartyRefOrPartyRoleRef>,
    ///Relationship to resource usage
    #[serde(rename = "resourceUsage")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub resource_usage: Vec<ResourceUsageRef>,
    ///Service reference, for when Service is used by other entities.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub service: Option<ServiceRef>,
    ///A list of characteristics that characterize this Service Usage (usageCharacteristic [*])
    #[serde(rename = "usageCharacteristic")]
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub usage_characteristic: Vec<Characteristic>,
    ///Date of usage
    #[serde(rename = "usageDate")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub usage_date: Option<crate::DateTime>,
    ///`UsageSpecification` reference. `UsageSpecification` is a detailed description of a service usage event that are of interest to the business. It is comprised of characteristics, which define all attributes known for a particular type of usage.
    #[serde(rename = "usageSpecification")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub usage_specification: Option<ServiceUsageSpecificationRef>,
    ///Type of usage
    #[serde(rename = "usageType")]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub usage_type: Option<String>,
}

impl IsAddressable for ServiceUsage {
    fn get_objects() -> Vec<&'static str> {
        super::get_objects()
    }
}

impl std::fmt::Display for ServiceUsage {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
        write!(f, "{}", serde_json::to_string(self).unwrap())
    }
}
impl std::ops::Deref for ServiceUsage {
    type Target = Entity;
    fn deref(&self) -> &Self::Target {
        &self.entity
    }
}
impl std::ops::DerefMut for ServiceUsage {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.entity
    }
}