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
use crate::api::*;
use crate::{ApiError, ClientConfig, HttpClient, QueryBuilder, RequestOptions};
use crate::{AsyncPaginator, PaginationResult};
use reqwest::Method;
pub struct RefundsClient {
pub http_client: HttpClient,
}
impl RefundsClient {
pub fn new(config: ClientConfig) -> Result<Self, ApiError> {
Ok(Self {
http_client: HttpClient::new(config.clone())?,
})
}
/// Returns a paginated list of refunds. Supports filtering by status, currency, customer, and payment. Sortable by status, amount, currency, and created date.
///
/// # Arguments
///
/// * `currency` - Filter by ISO 4217 currency code
/// * `customer_id` - Filter by customer ID
/// * `limit` - Number of items to return per page
/// * `offset` - Number of items to skip
/// * `payment_id` - Filter by payment ID
/// * `sort` - Sort field and direction in format field:order
/// * `status` - Filter by refund status. Pass a comma-separated list to match any.
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use alguna::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// api_key: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Alguna::new(config).expect("Failed to build client");
/// client
/// .refunds
/// .list(
/// &RefundsListQueryRequest {
/// currency: Some("USD".to_string()),
/// customer_id: Some("cust_abc123".to_string()),
/// limit: Some(20),
/// offset: Some(0),
/// payment_id: Some("pay_abc123".to_string()),
/// sort: Some("created_at:desc".to_string()),
/// status: vec![],
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn list(
&self,
request: &RefundsListQueryRequest,
options: Option<RequestOptions>,
) -> Result<RefundListResponse, ApiError> {
self.http_client
.execute_request(
Method::GET,
"refunds",
None,
QueryBuilder::new()
.string("currency", request.currency.clone())
.string("customer_id", request.customer_id.clone())
.int("limit", request.limit.clone())
.int("offset", request.offset.clone())
.string("payment_id", request.payment_id.clone())
.string("sort", request.sort.clone())
.string("status", {
let joined = request
.status
.iter()
.flatten()
.map(|value| value.to_string())
.collect::<Vec<_>>()
.join(",");
if joined.is_empty() {
None
} else {
Some(joined)
}
})
.build(),
options,
)
.await
}
pub async fn list_paginated(
&self,
request: &RefundsListQueryRequest,
options: Option<RequestOptions>,
) -> Result<AsyncPaginator<RefundResponse>, ApiError> {
let http_client = std::sync::Arc::new(self.http_client.clone());
let base_query_params = QueryBuilder::new()
.string("currency", request.currency.clone())
.string("customer_id", request.customer_id.clone())
.int("limit", request.limit.clone())
.string("payment_id", request.payment_id.clone())
.string("sort", request.sort.clone())
.string("status", {
let joined = request
.status
.iter()
.flatten()
.map(|value| value.to_string())
.collect::<Vec<_>>()
.join(",");
if joined.is_empty() {
None
} else {
Some(joined)
}
})
.build();
let options_clone = options.clone();
AsyncPaginator::new(
http_client,
move |client, page_token| {
let mut query_params: Vec<(String, String)> =
base_query_params.clone().unwrap_or_default();
// Use page_token as offset/page number (start from 0 if None)
let current_page = page_token.unwrap_or_else(|| "0".to_string());
query_params.push(("offset".to_string(), current_page.clone()));
let page_size: Option<i64> = query_params
.iter()
.find(|(name, _)| name == "limit")
.and_then(|(_, value)| value.parse::<i64>().ok());
let options_for_request = options_clone.clone();
// Clone captured variables to move into the async block
Box::pin(async move {
let raw_response = client
.execute_request_raw::<serde_json::Value>(
Method::GET,
"refunds",
None,
Some(query_params),
options_for_request,
)
.await?;
let response = raw_response.body;
// Extract pagination info from response
// Generic field extraction for offset pagination
let items: Vec<serde_json::Value> = response
.get("data")
.and_then(|v| v.as_array())
.map(|arr| arr.clone())
.unwrap_or_default();
let has_next_page = match page_size {
Some(size) => items.len() as i64 >= size.min(100),
None => !items.is_empty(),
};
let next_cursor: Option<String> = if has_next_page {
let current_offset: i64 = current_page.parse().unwrap_or(0);
Some((current_offset + items.len() as i64).to_string())
} else {
None
};
let items = items
.into_iter()
.map(serde_json::from_value::<RefundResponse>)
.collect::<Result<Vec<_>, _>>()
.map_err(ApiError::Serialization)?;
Ok(PaginationResult {
items,
next_cursor,
has_next_page,
response: Some(response),
status_code: raw_response.status_code,
headers: raw_response.headers,
})
})
},
request.offset.map(|offset| offset.to_string()),
)
}
/// Creates a refund against a payment. For partial or full refunds of invoices, prefer issuing a credit note first via Create Credit Note and applying it, which handles accounting and gives the customer a paper trail. Direct refunds are best for cases where no credit note is needed.
///
/// # Arguments
///
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use alguna::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// api_key: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Alguna::new(config).expect("Failed to build client");
/// client
/// .refunds
/// .create(
/// &CreateRefundRequest {
/// amount: "99.00".to_string(),
/// payment_id: "pay_01H1VECT".to_string(),
/// reason: None,
/// statement_descriptor: None,
/// },
/// None,
/// )
/// .await;
/// }
/// ```
pub async fn create(
&self,
request: &CreateRefundRequest,
options: Option<RequestOptions>,
) -> Result<RefundResponse, ApiError> {
self.http_client
.execute_request(
Method::POST,
"refunds",
Some(serde_json::to_value(request).map_err(ApiError::Serialization)?),
None,
options,
)
.await
}
/// Fetches a single refund by ID.
///
/// # Arguments
///
/// * `id` - Unique identifier for the refund
/// * `options` - Additional request options such as headers, timeout, etc.
///
/// # Returns
///
/// JSON response from the API
///
/// # Examples
///
/// ```no_run
/// use alguna::prelude::*;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ClientConfig {
/// api_key: Some("<token>".to_string()),
/// ..Default::default()
/// };
/// let client = Alguna::new(config).expect("Failed to build client");
/// client.refunds.get(&"id".to_string(), None).await;
/// }
/// ```
pub async fn get(
&self,
id: &str,
options: Option<RequestOptions>,
) -> Result<RefundResponse, ApiError> {
self.http_client
.execute_request(Method::GET, &format!("refunds/{}", id), None, None, options)
.await
}
}