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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use reqwest::Method;
pub struct PaymentLinkClient {
pub http_client: HttpClient,
}
impl PaymentLinkClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Generates a payment link for an invoice from the invoice ID.
///
/// # Arguments
///
/// * `id_invoice` - Invoice ID
/// * `amount_fixed` - Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
/// * `mail_2` - List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn add_pay_link_from_invoice(
&self,
id_invoice: i64,
request: &AddPayLinkFromInvoiceRequest,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::POST,
&format!("PaymentLink/{}", id_invoice),
Some(serde_json::to_value(&request.body).map_err(ApiError::Serialization)?),
QueryBuilder::new()
.bool("amountFixed", request.amount_fixed.clone())
.string("mail2", request.mail_2.clone())
.build(),
options,
)
.await
}
/// Generates a payment link for a bill from the bill ID. The vendor receives a secure page where they can select their preferred payment method (ACH, virtual card, or check) and complete the payment.
///
/// # Arguments
///
/// * `bill_id` - The Payabli ID for the bill.
/// * `amount_fixed` - Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
/// * `mail_2` - List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn add_pay_link_from_bill(
&self,
bill_id: i64,
request: &AddPayLinkFromBillRequest,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::POST,
&format!("PaymentLink/bill/{}", bill_id),
Some(serde_json::to_value(&request.body).map_err(ApiError::Serialization)?),
QueryBuilder::new()
.bool("amountFixed", request.amount_fixed.clone())
.string("mail2", request.mail_2.clone())
.build(),
options,
)
.await
}
/// Deletes a payment link by ID.
///
/// # Arguments
///
/// * `pay_link_id` - ID for the payment link.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn delete_pay_link_from_id(
&self,
pay_link_id: &str,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::DELETE,
&format!("PaymentLink/{}", pay_link_id),
None,
None,
options,
)
.await
}
/// Retrieves a payment link by ID.
///
/// # Arguments
///
/// * `paylink_id` - ID for payment link
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn get_pay_link_from_id(
&self,
paylink_id: &str,
options: Option<RequestOptions>,
) -> Result<GetPayLinkFromIdResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("PaymentLink/load/{}", paylink_id),
None,
None,
options,
)
.await
}
/// Send a payment link to the specified email addresses or phone numbers.
///
/// # Arguments
///
/// * `pay_link_id` - ID for the payment link.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn push_pay_link_from_id(
&self,
pay_link_id: &str,
request: &PushPayLinkRequest,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::POST,
&format!("PaymentLink/push/{}", pay_link_id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Refresh a payment link's content after an update.
///
/// # Arguments
///
/// * `pay_link_id` - ID for the payment link.
/// * `amount_fixed` - Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn refresh_pay_link_from_id(
&self,
pay_link_id: &str,
request: &RefreshPayLinkFromIdQueryRequest,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("PaymentLink/refresh/{}", pay_link_id),
None,
QueryBuilder::new()
.bool("amountFixed", request.amount_fixed.clone())
.build(),
options,
)
.await
}
/// Sends a payment link to the specified email addresses.
///
/// # Arguments
///
/// * `pay_link_id` - ID for the payment link.
/// * `attachfile` - When `true`, attaches a PDF version of invoice to the email.
/// * `mail_2` - List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn send_pay_link_from_id(
&self,
pay_link_id: &str,
request: &SendPayLinkFromIdQueryRequest,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::GET,
&format!("PaymentLink/send/{}", pay_link_id),
None,
QueryBuilder::new()
.bool("attachfile", request.attachfile.clone())
.string("mail2", request.mail_2.clone())
.build(),
options,
)
.await
}
/// Updates a payment link's details.
///
/// # Arguments
///
/// * `pay_link_id` - ID for the payment link.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn update_pay_link_from_id(
&self,
pay_link_id: &str,
request: &PayLinkUpdateData,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::PUT,
&format!("PaymentLink/update/{}", pay_link_id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Generates a vendor payment link for a specific bill lot number. This allows you to pay all bills with the same lot number for a vendor with a single payment link.
///
/// # Arguments
///
/// * `lot_number` - Lot number of the bills to pay. All bills with this lot number will be included.
/// * `vendor_number` - The vendor number for the vendor being paid with this payment link.
/// * `mail_2` - List of recipient email addresses. When there is more than one, separate them by a semicolon (;).
/// * `amount_fixed` - Indicates whether customer can modify the payment amount. A value of `true` means the amount isn't modifiable, a value `false` means the payor can modify the amount to pay.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn add_pay_link_from_bill_lot_number(
&self,
lot_number: &str,
request: &AddPayLinkFromBillLotNumberRequest,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::POST,
&format!("PaymentLink/bill/lotNumber/{}", lot_number),
Some(serde_json::to_value(&request.body).map_err(ApiError::Serialization)?),
QueryBuilder::new()
.serialize("entryPoint", Some(request.entry_point.clone()))
.string("vendorNumber", request.vendor_number.clone())
.string("mail2", request.mail_2.clone())
.string("amountFixed", request.amount_fixed.clone())
.build(),
options,
)
.await
}
/// Partially updates a Pay Out payment link's content, expiration date, and/or status. Use this to modify the payment page configuration, extend or change the expiration, or cancel a link. Updating the expiration date of an expired link reactivates it to Active status.
///
/// # Arguments
///
/// * `paylink_id` - ID for the payment link.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn patch_out_payment_link(
&self,
paylink_id: &str,
request: &PatchOutPaymentLinkRequest,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::PATCH,
&format!("PaymentLink/out/{}", paylink_id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Updates the payment page content for a Pay Out payment link. Use this to change the branding, messaging, payment methods offered, or other page configuration.
///
/// # Arguments
///
/// * `paylink_id` - ID for the payment link.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
pub async fn update_pay_link_out_from_id(
&self,
paylink_id: &str,
request: &PaymentPageRequestBodyOut,
options: Option<RequestOptions>,
) -> Result<PayabliApiResponsePaymentLinks, ApiError> {
self.http_client
.execute_request(
Method::PATCH,
&format!("PaymentLink/updateOut/{}", paylink_id),
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
}