assinafy 0.1.1

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

//! Field-definition models.

use serde::{Deserialize, Serialize};

/// A workspace-scoped field definition.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct FieldDefinition {
    /// Resource discriminator, when returned by the API.
    #[serde(default)]
    pub resource: Option<String>,
    /// Field identifier.
    pub id: String,
    /// Human-readable field name.
    pub name: String,
    /// Field type, such as `text`, `email`, `signature`, or `initial`.
    #[serde(rename = "type")]
    pub kind: String,
    /// Optional validation regular expression.
    #[serde(default)]
    pub regex: Option<String>,
    /// Whether this field is predefined by the platform.
    #[serde(default)]
    pub is_pre_defined: Option<bool>,
    /// Whether this field is active.
    #[serde(default)]
    pub is_active: bool,
    /// Whether this field is required when filled.
    #[serde(default)]
    pub is_required: Option<bool>,
    /// Whether this is a standard built-in field.
    #[serde(default)]
    pub is_standard: Option<bool>,
    /// Whether this field is read-only.
    #[serde(default)]
    pub is_read_only: Option<bool>,
    /// Whether this field is visible to signers.
    #[serde(default)]
    pub is_visible: Option<bool>,
}

/// Description of a supported field type.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct FieldType {
    /// Stable field type identifier.
    #[serde(rename = "type")]
    pub kind: String,
    /// Display name.
    pub name: String,
}

/// Result returned by field-value validation endpoints.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct FieldValidationResult {
    /// Field type, when included.
    #[serde(default, rename = "type")]
    pub kind: Option<String>,
    /// Field definition identifier, when included.
    #[serde(default)]
    pub field_id: Option<String>,
    /// Whether the value passed validation.
    pub success: bool,
    /// Validation error message. Empty when validation succeeds.
    #[serde(default)]
    pub error_message: String,
}