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
//! Refund types for the Payrix API.
//!
//! Refunds represent the return of funds from a previously completed entry
//! back to the customer.
//!
//! **OpenAPI schema:** `refundsResponse`
use payrix_macros::PayrixEntity;
use serde::{Deserialize, Serialize};
use super::PayrixId;
// =============================================================================
// REFUND STRUCT
// =============================================================================
/// A Payrix refund.
///
/// Refunds return funds from an entry back to the customer.
///
/// **OpenAPI schema:** `refundsResponse`
///
/// See API_INCONSISTENCIES.md for known deviations from this spec.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, PayrixEntity)]
#[payrix(create = CreateRefund, update = UpdateRefund)]
#[cfg_attr(feature = "sqlx", derive(sqlx::FromRow))]
#[serde(rename_all = "camelCase")]
pub struct Refund {
/// The ID of this resource.
///
/// **OpenAPI type:** string
#[payrix(readonly)]
pub id: PayrixId,
/// The date and time at which this resource was created.
///
/// Format: `YYYY-MM-DD HH:MM:SS.SSSS`
///
/// **OpenAPI type:** string (pattern: `^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$`)
#[payrix(readonly)]
#[serde(default)]
pub created: Option<String>,
/// The date and time at which this resource was modified.
///
/// Format: `YYYY-MM-DD HH:MM:SS.SSSS`
///
/// **OpenAPI type:** string (pattern: `^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}.\d{4}$`)
#[payrix(readonly)]
#[serde(default)]
pub modified: Option<String>,
/// The identifier of the Login that created this resource.
///
/// **OpenAPI type:** string (ref: creator)
#[payrix(readonly)]
#[serde(default)]
pub creator: Option<PayrixId>,
/// The identifier of the Login that last modified this resource.
///
/// **OpenAPI type:** string
#[payrix(readonly)]
#[serde(default)]
pub modifier: Option<PayrixId>,
/// The identifier of the Entry that is being refunded.
///
/// **OpenAPI type:** string (ref: refundsModelEntry)
#[payrix(create_only)]
#[serde(default)]
pub entry: Option<PayrixId>,
/// A description of this Refund.
///
/// This field is stored as a text string (0-100 characters).
///
/// **OpenAPI type:** string
#[payrix(mutable)]
#[serde(default)]
pub description: Option<String>,
/// The amount of this Refund.
///
/// This field is specified in cents (up to three decimal points).
/// If not set, the API uses the amount from the related Entry resource.
///
/// **OpenAPI type:** number
#[serde(default)]
pub amount: Option<f64>,
// =========================================================================
// NESTED RELATIONS (expandable via API)
// =========================================================================
/// Entry associated with this refund.
///
/// **OpenAPI type:** entriesResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub entries: Option<serde_json::Value>,
/// Pending entries associated with this refund.
///
/// **OpenAPI type:** pendingEntriesResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub pending_entries: Option<serde_json::Value>,
}
// =============================================================================
// TESTS
// =============================================================================
#[cfg(test)]
mod tests {
use super::*;
// ==================== Refund Struct Tests ====================
#[test]
fn refund_deserialize_full() {
let json = r#"{
"id": "t1_ref_12345678901234567890123",
"created": "2024-01-01 00:00:00.0000",
"modified": "2024-01-02 23:59:59.9999",
"creator": "t1_lgn_12345678901234567890123",
"modifier": "t1_lgn_12345678901234567890124",
"entry": "t1_ent_12345678901234567890123",
"description": "Customer refund request",
"amount": 2500.5
}"#;
let refund: Refund = serde_json::from_str(json).unwrap();
assert_eq!(refund.id.as_str(), "t1_ref_12345678901234567890123");
assert_eq!(refund.created, Some("2024-01-01 00:00:00.0000".to_string()));
assert_eq!(refund.modified, Some("2024-01-02 23:59:59.9999".to_string()));
assert_eq!(refund.creator.as_ref().map(|c| c.as_str()), Some("t1_lgn_12345678901234567890123"));
assert_eq!(refund.modifier.as_ref().map(|m| m.as_str()), Some("t1_lgn_12345678901234567890124"));
assert_eq!(refund.entry.as_ref().map(|e| e.as_str()), Some("t1_ent_12345678901234567890123"));
assert_eq!(refund.description, Some("Customer refund request".to_string()));
assert_eq!(refund.amount, Some(2500.5));
}
#[test]
fn refund_deserialize_minimal() {
let json = r#"{"id": "t1_ref_12345678901234567890123"}"#;
let refund: Refund = serde_json::from_str(json).unwrap();
assert_eq!(refund.id.as_str(), "t1_ref_12345678901234567890123");
assert!(refund.created.is_none());
assert!(refund.modified.is_none());
assert!(refund.creator.is_none());
assert!(refund.modifier.is_none());
assert!(refund.entry.is_none());
assert!(refund.description.is_none());
assert!(refund.amount.is_none());
}
#[test]
fn refund_amount_decimal() {
let json = r#"{
"id": "t1_ref_12345678901234567890123",
"amount": 1234.567
}"#;
let refund: Refund = serde_json::from_str(json).unwrap();
assert_eq!(refund.amount, Some(1234.567));
}
#[test]
fn refund_amount_integer() {
let json = r#"{
"id": "t1_ref_12345678901234567890123",
"amount": 2500
}"#;
let refund: Refund = serde_json::from_str(json).unwrap();
assert_eq!(refund.amount, Some(2500.0));
}
#[test]
#[cfg(not(feature = "sqlx"))]
fn refund_with_nested_relations() {
let json = r#"{
"id": "t1_ref_12345678901234567890123",
"entries": {"id": "t1_ent_12345678901234567890123"},
"pendingEntries": {"id": "t1_pen_12345678901234567890123"}
}"#;
let refund: Refund = serde_json::from_str(json).unwrap();
assert!(refund.entries.is_some());
assert!(refund.pending_entries.is_some());
}
#[test]
fn refund_serialize_roundtrip() {
let json = r#"{
"id": "t1_ref_12345678901234567890123",
"entry": "t1_ent_12345678901234567890123",
"description": "Test refund",
"amount": 1000.0
}"#;
let refund: Refund = serde_json::from_str(json).unwrap();
let serialized = serde_json::to_string(&refund).unwrap();
let deserialized: Refund = serde_json::from_str(&serialized).unwrap();
assert_eq!(refund.id, deserialized.id);
assert_eq!(refund.entry, deserialized.entry);
assert_eq!(refund.description, deserialized.description);
assert_eq!(refund.amount, deserialized.amount);
}
}