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

use serde::{Deserialize, Serialize};

/// This struct defines a signer with the attributes described in the API documentation
/// The optional fields only make sense in the Responses body.
/// Check [clicksign docs](https://developers.clicksign.com/docs/criar-signatario) for detailed info.
#[derive(Debug, Serialize, Deserialize)]
pub struct Signer {
    /// Unique identifier for the signer into clicksign environment
    pub key: Option<String>,
    /// Email of the signer who must sign the document
    pub email: String,
    /// Phone number for sending Whatsapp or SMS. (Must be sent 11 numbers)
    pub phone_number: String,
    /// Authentication type for signing (email, sms, whatsapp, API and/or pix).
    pub auths: Vec<String>,
    /// Signer's full name.
    pub name: String,
    /// Signer's CPF
    pub documentation: String,
    /// Signer's date of birth
    pub birthday: String,
    /// The default value is true. If false, isn't possible to send the fields "documentation" and "birthday".
    pub has_documentation: bool,
    /// Informs how the signer receives the signature confirmation and finalized document notifications.
    pub delivery: String,
    /// Check [clicksign documentation](https://developers.clicksign.com/docs/criar-signatario#atributos-para-a-cria%C3%A7%C3%A3o-de-signat%C3%A1rios) for more info about this field.
    pub selfie_enabled: bool,
    /// Check [clicksign documentation](https://developers.clicksign.com/docs/criar-signatario#atributos-para-a-cria%C3%A7%C3%A3o-de-signat%C3%A1rios) for more info about this field.
    pub handwritten_enabled: bool,
    /// Check [clicksign documentation](https://developers.clicksign.com/docs/criar-signatario#atributos-para-a-cria%C3%A7%C3%A3o-de-signat%C3%A1rios) for more info about this field.
    pub official_document_enabled: bool,
    /// Check [clicksign documentation](https://developers.clicksign.com/docs/criar-signatario#atributos-para-a-cria%C3%A7%C3%A3o-de-signat%C3%A1rios) for more info about this field.
    pub liveness_enabled: bool,
    /// Signer creation datetime
    pub created_at: Option<String>,
    /// Signer update datetime
    pub updated_at: Option<String>,
}

/// This struct defines a request and response body for POST /api/v1/lists endpoint
/// The optional fields only make sense in the Responses body.
/// Check [clicksign docs](https://developers.clicksign.com/docs/adicionar-signatario-a-documento) for detailed info.
#[derive(Debug, Serialize, Deserialize)]
pub struct SignerToDocument {
    /// A key for clicksign internal stuffs (Response-only field)
    pub key: Option<String>,
    /// A key for clicksign internal stuffs (Response-only field)
    pub request_signature_key: Option<String>,
    /// Unique key of the document within Clicksign
    pub document_key: String,
    /// Signer's unique key within Clicksign
    pub signer_key: String,
    /// Under what title the signature will be carried out
    pub sign_as: String,
    /// Event creation datetime (Response-only field)
    pub created_at: Option<String>,
    /// Event update datetime (Response-only field)
    pub updated_at: Option<String>,
    /// URL to signing document (Response-only field)
    pub url: Option<String>,
    /// The message will be sent in the body of the signature request email to the signers.
    pub message: String,
}