scout_rs 0.95.95

A Rust client for the synchornizing state with the Scout database
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

use serde::{Deserialize, Serialize};

/// The entity a document template applies to (`public.document_entity`).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum DocumentEntity {
    User,
    Herd,
    Device,
    Product,
    OperatingContext,
}

impl From<&str> for DocumentEntity {
    fn from(s: &str) -> Self {
        match s {
            "user" => DocumentEntity::User,
            "herd" => DocumentEntity::Herd,
            "device" => DocumentEntity::Device,
            "product" => DocumentEntity::Product,
            "operating_context" => DocumentEntity::OperatingContext,
            _ => DocumentEntity::User,
        }
    }
}

/// A document category/template per locality and issuer (`public.document_templates`).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DocumentTemplate {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<i64>,
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub issuer_id: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entity_for: Option<DocumentEntity>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub localization_id: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub compliance_resource_id: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub document_condition_id: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub identifier_label: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub system_tag: Option<String>,
    #[serde(default)]
    pub categories: Vec<String>,
    #[serde(default)]
    pub is_opspec: bool,
    #[serde(default)]
    pub is_shared: bool,
    #[serde(default)]
    pub uses_expiry: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub inserted_at: Option<String>,
}

#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct DocumentTemplatePatch {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub issuer_id: Option<Option<i64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub entity_for: Option<Option<DocumentEntity>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub localization_id: Option<Option<i64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub compliance_resource_id: Option<Option<i64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub document_condition_id: Option<Option<i64>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub identifier_label: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub system_tag: Option<Option<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub categories: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_opspec: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub is_shared: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub uses_expiry: Option<bool>,
}

/// Maps a document template to an ability that makes its documents relevant for a user (`public.document_template_abilities`).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct DocumentTemplateAbility {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub id: Option<i64>,
    pub document_template_id: i64,
    pub ability_id: i64,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub inserted_at: Option<String>,
}