assinafy 0.1.2

Idiomatic async Rust SDK for the Assinafy electronic signature API (https://api.assinafy.com.br/v1).
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

//! Template models.

use std::fmt;

use serde::{Deserialize, Serialize};

use super::tag::Tag;

/// Template lifecycle status.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TemplateStatus {
    /// Upload in progress.
    #[serde(alias = "Uploading")]
    Uploading,
    /// Upload complete; processing not started.
    #[serde(alias = "Uploaded")]
    Uploaded,
    /// Server-side processing in progress.
    #[serde(alias = "Processing")]
    Processing,
    /// Ready to instantiate documents from.
    #[serde(alias = "Ready")]
    Ready,
    /// Processing failed.
    #[serde(alias = "Failed")]
    Failed,
    /// Any value the SDK does not yet model.
    #[serde(untagged)]
    Unknown(String),
}

impl fmt::Display for TemplateStatus {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let s = match self {
            TemplateStatus::Uploading => "uploading",
            TemplateStatus::Uploaded => "uploaded",
            TemplateStatus::Processing => "processing",
            TemplateStatus::Ready => "ready",
            TemplateStatus::Failed => "failed",
            TemplateStatus::Unknown(s) => s.as_str(),
        };
        f.write_str(s)
    }
}

/// A reusable document template.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Template {
    /// Resource discriminator (always `"template"` when present).
    #[serde(default)]
    pub resource: Option<String>,
    /// Template identifier.
    pub id: String,
    /// Template (PDF) filename.
    pub name: String,
    /// Default document name when creating a document from this template.
    #[serde(default)]
    pub document_name: Option<String>,
    /// Default invitation message.
    #[serde(default)]
    pub message: Option<String>,
    /// Lifecycle status.
    pub status: TemplateStatus,
    /// Pages within the template.
    #[serde(default)]
    pub pages: Vec<TemplatePage>,
    /// Roles defined on the template.
    #[serde(default)]
    pub roles: Vec<TemplateRole>,
    /// Tags attached to the template itself.
    #[serde(default)]
    pub tags: Vec<Tag>,
    /// Tags that will be automatically applied to documents created from this
    /// template. Only returned by the single-template endpoint.
    #[serde(default)]
    pub default_document_tags: Vec<TemplateTagRef>,
    /// Creation timestamp.
    #[serde(default)]
    pub created_at: Option<String>,
    /// Last modification timestamp.
    #[serde(default)]
    pub updated_at: Option<String>,
}

/// A page within a template.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TemplatePage {
    /// Page identifier.
    pub id: String,
    /// 1-based page number.
    pub number: u32,
    /// Page height in pixels.
    pub height: u32,
    /// Page width in pixels.
    pub width: u32,
    /// Pre-signed download URL.
    #[serde(default)]
    pub download_url: Option<String>,
    /// Field placements on this page.
    #[serde(default)]
    pub fields: Vec<TemplateField>,
}

/// A field placement on a template page.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TemplateField {
    /// Placement identifier.
    pub id: String,
    /// Field type identifier (signature, initial, text, etc.).
    pub field_id: String,
    /// Role identifier assigned to this field.
    pub role_id: String,
    /// Field label.
    pub label: String,
    /// Free-form display settings.
    #[serde(default)]
    pub display_settings: Option<serde_json::Value>,
    /// Creation timestamp.
    #[serde(default)]
    pub created_at: Option<String>,
    /// Last modification timestamp.
    #[serde(default)]
    pub updated_at: Option<String>,
}

/// A role defined on a template.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TemplateRole {
    /// Role identifier.
    pub id: String,
    /// Display name.
    pub name: String,
    /// Assignment type (`"Editor"`, etc.).
    pub assignment_type: String,
    /// Creation timestamp.
    #[serde(default)]
    pub created_at: Option<String>,
    /// Last modification timestamp.
    #[serde(default)]
    pub updated_at: Option<String>,
}

/// Reference to a tag included in a template's default document tags.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct TemplateTagRef {
    /// Tag identifier.
    pub id: String,
    /// Tag name.
    pub name: String,
    /// Tag color, when included by the API.
    #[serde(default)]
    pub color: Option<String>,
}