clicksign 0.2.8

Unofficial Rust library for the Clicksign API
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Defines a document template inside the Clicksign
#[derive(Debug, Serialize, Deserialize)]
pub struct DocumentTemplate {
    /// Unique key within Clicksign
    pub key: String,
    /// Data to fill in the template placeholders
    pub data: HashMap<String, String>,
}

/// Defines the field "data" of a document event.
#[derive(Debug, Serialize, Deserialize)]
pub struct EventData {
    /// Information of the user who created the document
    pub user: HashMap<String, String>,
    /// Information about the Clicksign account in whinch the document was created
    pub account: HashMap<String, String>,
    // TODO: I'm not sure about the difference between this deadline_at and the Document.deadline_at
    deadline_at: String,
    // TODO: I'm not sure about the difference between this auto_close and the Document.auto_close
    auto_close: bool,
    // TODO: I'm not sure about the difference between this locale and the Document.locale
    locale: String,
}

/// This struct models a document event
#[derive(Debug, Serialize, Deserialize)]
pub struct DocumentEvent {
    /// Event name
    pub name: String,
    /// Event data
    pub data: EventData,
    /// Datetime the event occurred
    pub occurred_at: String
}

/// This struct defines a metainformation about the document
#[derive(Debug, Serialize, Deserialize)]
pub struct Document {
    /// Unique key within Clicksign
    pub key: Option<String>,
    /// Full path for the document within Clicksign
    pub path: String,
    /// Name of generated file
    pub filename: Option<String>,
    /// Datetime for the last update in the document
    pub updated_at: Option<String>,
    /// Document finalization datetime
    pub finished_at: Option<String>,
    /// Document deadline
    pub deadline_at: Option<String>,
    /// Status of the document
    pub status: Option<String>,
    /// Indicates whether the document will be automatically finalized when all the signers sign.
    pub auto_close: Option<bool>,
    /// Indicates the document's locale
    pub locale: Option<String>,
    /// Metinformation about the document
    pub metadata: Option<HashMap<String, String>>,
    /// Missing information in the clicksign documentation
    pub sequence_enabled: Option<bool>,
    /// Missing information in the clicksign documentation
    pub signable_group: Option<String>,
    /// Missing information in the clicksign documentation
    pub remind_interval: Option<String>,
    /// Document download information
    pub downloads: Option<HashMap<String, String>>,
    /// Document template data
    pub template: DocumentTemplate,
    /// List of signers in the document
    pub signers: Option<Vec<String>>,
    /// Lists of events that occurred in the document
    pub events: Option<Vec<DocumentEvent>>
}