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
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
pub struct DocumentsClient {
pub http_client: HttpClient,
}
impl DocumentsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Retrieve all documents linked to a client.
///
/// # Arguments
///
/// * `order_by` - Field to order the results by, e.g., 'created_at:desc,updated_at:asc'
/// * `q` - Query string for filtering. Format: "field:operator:value;...". Supported fields: id, client_id, loan_id, installment_id, waterfall_id, category, file_name, document_date, folder_path. Supported operators: is, in, not_in, contains, not_contains, like, not_like, ilike, not_ilike, gt, gte, lt, lte, starts_with, ends_with, is_null, is_not_null.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn list_documents(
&self,
request: &ListDocumentsQueryRequest,
options: Option<RequestOptions>,
) -> Result<PaginatedResponseDocumentResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"v2/documents",
None,
QueryBuilder::new()
.serialize("client_id", request.client_id.clone())
.serialize("loan_id", request.loan_id.clone())
.serialize("installment_id", request.installment_id.clone())
.serialize("waterfall_id", request.waterfall_id.clone())
.serialize("page", request.page.clone())
.serialize("page_size", request.page_size.clone())
.serialize("order_by", request.order_by.clone())
.serialize("q", request.q.clone())
.build(),
options,
)
.await
}
/// Upload a new document related to a client or loan, such as financial statements or KYC files.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn upload_document(
&self,
request: &UploadDocumentRequest,
options: Option<RequestOptions>,
) -> Result<DocumentResponse, ApiError> {
self.http_client
.execute_multipart_request(
Method::POST,
"v2/documents",
request.clone().to_multipart(),
QueryBuilder::new()
.serialize("client_id", request.client_id.clone())
.serialize("loan_id", request.loan_id.clone())
.serialize("installment_id", request.installment_id.clone())
.serialize("waterfall_id", request.waterfall_id.clone())
.build(),
options,
)
.await
}
/// Retrieve all available document categories.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn get_available_document_categories(
&self,
options: Option<RequestOptions>,
) -> Result<AvailableDocumentCategoriesResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"v2/documents/available-categories",
None,
None,
options,
)
.await
}
/// Retrieve details for a specific document using its document ID.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn get_document_by_id(
&self,
document_id: &str,
options: Option<RequestOptions>,
) -> Result<DocumentResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("v2/documents/{}", document_id),
None,
None,
options,
)
.await
}
/// Delete a specific document by using its document ID.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// Empty response
pub async fn delete_document(
&self,
document_id: &str,
options: Option<RequestOptions>,
) -> Result<(), ApiError> {
self.http_client
.execute_request(
Method::DELETE,
&format!("v2/documents/{}", document_id),
None,
None,
options,
)
.await
}
}