rain-sdk 1.2.0

A modern, type-safe Rust SDK for the Rain xyz 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
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

//! Common types and models for the Rain SDK

use serde::{Deserialize, Serialize};
use uuid::Uuid;

/// Address structure (PhysicalAddress in OpenAPI)
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Address {
    pub line1: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub line2: Option<String>,
    pub city: String,
    pub region: String,
    pub postal_code: String,
    pub country_code: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
}

/// Application link with parameters
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ApplicationLink {
    pub url: String,
    pub params: ApplicationLinkParams,
}

/// Application link parameters
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ApplicationLinkParams {
    pub user_id: Uuid,
}

/// Person information structure
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PersonInfo {
    pub id: Uuid,
    pub first_name: String,
    pub last_name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub birth_date: Option<String>, // ISO date format
    #[serde(skip_serializing_if = "Option::is_none")]
    pub national_id: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub country_of_issue: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub phone_country_code: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub phone_number: Option<String>,
    pub address: Address,
}

/// Application status enum
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum ApplicationStatus {
    Approved,
    Pending,
    NeedsInformation,
    NeedsVerification,
    ManualReview,
    Denied,
    Locked,
    Canceled,
}

/// Document type for company documents
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum CompanyDocumentType {
    DirectorsRegistry,
    StateRegistry,
    IncumbencyCert,
    ProofOfAddress,
    TrustAgreement,
    InformationStatement,
    IncorporationCert,
    IncorporationArticles,
    ShareholderRegistry,
    GoodStandingCert,
    PowerOfAttorney,
    Other,
}

/// Document type for user/UBO documents
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum UserDocumentType {
    IdCard,
    Passport,
    Drivers,
    ResidencePermit,
    UtilityBill,
    Selfie,
    VideoSelfie,
    ProfileImage,
    IdDocPhoto,
    Agreement,
    Contract,
    DriversTranslation,
    InvestorDoc,
    VehicleRegistrationCertificate,
    IncomeSource,
    PaymentMethod,
    BankCard,
    CovidVaccinationForm,
    Other,
}

/// Document side enum
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum DocumentSide {
    Front,
    Back,
}