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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
use std::collections::HashMap;
pub struct InstallmentsClient {
pub http_client: HttpClient,
}
impl InstallmentsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Retrieve a list of all loan installments under your partner account. Supports optional filtering by loan or 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, status, client.name, expected_repayment_at. 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_installments(
&self,
request: &ListInstallmentsQueryRequest,
options: Option<RequestOptions>,
) -> Result<PaginatedResponseInstallmentResponseWithClientInfo, ApiError> {
self.http_client
.execute_request(
Method::GET,
"v2/installments",
None,
QueryBuilder::new()
.serialize("page", request.page.clone())
.serialize("page_size", request.page_size.clone())
.serialize("client_id", request.client_id.clone())
.serialize("loan_id", request.loan_id.clone())
.serialize("order_by", request.order_by.clone())
.serialize("q", request.q.clone())
.build(),
options,
)
.await
}
/// Add new installments to a loan with its specific loan ID. This endpoint is available to select partners and will trigger the recalculation of the IRR and interest amounts for all installments of the loan.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn add_installment(
&self,
request: &InstallmentCreatePayload,
options: Option<RequestOptions>,
) -> Result<Vec<InstallmentResponse>, ApiError> {
self.http_client
.execute_request(
Method::POST,
"v2/installments",
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Retrieve a list of payment promises recorded for installments under your partner account. Supports optional filtering by loan or 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, installment_id, status, promised_date, created_at. 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_payment_promises(
&self,
request: &ListPaymentPromisesQueryRequest,
options: Option<RequestOptions>,
) -> Result<PaginatedResponsePaymentPromiseResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"v2/installments/payment-promises",
None,
QueryBuilder::new()
.int("page", request.page.clone())
.serialize("page_size", request.page_size.clone())
.serialize("order_by", request.order_by.clone())
.serialize("q", request.q.clone())
.serialize("loan_id", request.loan_id.clone())
.serialize("client_id", request.client_id.clone())
.build(),
options,
)
.await
}
/// Record a payment promise made by a client for one of their installments. The promised date must be today or in the future.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn create_payment_promise(
&self,
request: &PaymentPromiseCreatePayload,
options: Option<RequestOptions>,
) -> Result<PaymentPromiseResponse, ApiError> {
self.http_client
.execute_request(
Method::POST,
"v2/installments/payment-promises",
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Retrieve detailed information for a specific installment using its installment ID.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn get_installment_by_id(
&self,
installment_id: &str,
options: Option<RequestOptions>,
) -> Result<InstallmentResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("v2/installments/{}", installment_id),
None,
None,
options,
)
.await
}
/// Update an installment's amount and expected repayment date with its specific installment ID. This endpoint is available to select partners and will trigger the recalculation of the IRR and interest amounts for all installments of the loan.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn edit_installment(
&self,
installment_id: &str,
request: &InstallmentEditPayload,
options: Option<RequestOptions>,
) -> Result<InstallmentResponse, ApiError> {
self.http_client
.execute_request(
Method::PUT,
&format!("v2/installments/{}", installment_id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Delete an installment with its specific installment ID. This endpoint is available to select partners and will trigger the recalculation of the IRR and interest amounts for all installments of the loan.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn delete_installment(
&self,
installment_id: &str,
options: Option<RequestOptions>,
) -> Result<HashMap<String, serde_json::Value>, ApiError> {
self.http_client
.execute_request(
Method::DELETE,
&format!("v2/installments/{}", installment_id),
None,
None,
options,
)
.await
}
}