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
//! Organization types for the Payrix API.
//!
//! Organizations group entities together for administrative purposes.
//!
//! **OpenAPI schema:** `orgsResponse`
use serde::{Deserialize, Serialize};
use super::PayrixId;
// =============================================================================
// ORG STRUCT
// =============================================================================
/// A Payrix organization.
///
/// Organizations group entities for management and reporting.
///
/// **OpenAPI schema:** `orgsResponse`
///
/// See API_INCONSISTENCIES.md for known deviations from this spec.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "sqlx", derive(sqlx::FromRow))]
#[serde(rename_all = "camelCase")]
pub struct Org {
/// The ID of this resource.
///
/// **OpenAPI type:** string
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}$`)
#[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}$`)
#[serde(default)]
pub modified: Option<String>,
/// The identifier of the Login that created this resource.
///
/// **OpenAPI type:** string (ref: creator)
#[serde(default)]
pub creator: Option<PayrixId>,
/// The identifier of the Login that last modified this resource.
///
/// **OpenAPI type:** string
#[serde(default)]
pub modifier: Option<PayrixId>,
/// The Login that owns this Org.
///
/// **OpenAPI type:** string (ref: orgsModelLogin)
#[serde(default)]
pub login: Option<PayrixId>,
/// The name of this Org.
///
/// This field is stored as a text string (0-100 characters).
///
/// **OpenAPI type:** string
#[serde(default)]
pub name: Option<String>,
/// A description of this Org.
///
/// This field is stored as a text string (0-100 characters).
///
/// **OpenAPI type:** string
#[serde(default)]
pub description: Option<String>,
/// This is used to specify a default fee for a group.
///
/// **OpenAPI type:** string
#[serde(default)]
pub default_fee_from_entity: Option<String>,
// =========================================================================
// NESTED RELATIONS (expandable via API)
// =========================================================================
/// Aggregations associated with this org.
///
/// **OpenAPI type:** array of aggregationsResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub aggregations: Option<Vec<serde_json::Value>>,
/// Billing modifiers associated with this org.
///
/// **OpenAPI type:** array of billingModifiersResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub billing_modifiers: Option<Vec<serde_json::Value>>,
/// Billings associated with this org.
///
/// **OpenAPI type:** array of billingsResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub billings: Option<Vec<serde_json::Value>>,
/// Decisions associated with this org.
///
/// **OpenAPI type:** array of decisionsResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub decisions: Option<Vec<serde_json::Value>>,
/// Embedded finance configuration associated with this org.
///
/// **OpenAPI type:** array of embeddedFinanceResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub embedded_finance: Option<Vec<serde_json::Value>>,
/// Fee modifiers associated with this org.
///
/// **OpenAPI type:** array of feeModifiersResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub fee_modifiers: Option<Vec<serde_json::Value>>,
/// Fees associated with this org.
///
/// **OpenAPI type:** array of feesResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub fees: Option<Vec<serde_json::Value>>,
/// Invoice parameters associated with this org.
///
/// **OpenAPI type:** array of invoiceParametersResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub invoice_parameters: Option<Vec<serde_json::Value>>,
/// Org entities associated with this org.
///
/// **OpenAPI type:** array of orgEntitiesResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub org_entities: Option<Vec<serde_json::Value>>,
/// Omni tokens associated with this org.
///
/// **OpenAPI type:** array of omniTokensResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub omni_tokens: Option<Vec<serde_json::Value>>,
/// Payout flows associated with this org.
///
/// **OpenAPI type:** array of payoutFlowsResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub payout_flows: Option<Vec<serde_json::Value>>,
/// Profit shares associated with this org.
///
/// **OpenAPI type:** array of profitSharesResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub profit_shares: Option<Vec<serde_json::Value>>,
/// Reserves associated with this org.
///
/// **OpenAPI type:** array of reservesResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub reserves: Option<Vec<serde_json::Value>>,
/// Revenue boosts associated with this org.
///
/// **OpenAPI type:** array of revenueBoostsResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub revenue_boosts: Option<Vec<serde_json::Value>>,
/// Secrets associated with this org.
///
/// **OpenAPI type:** array of secretsResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub secrets: Option<Vec<serde_json::Value>>,
/// Safer payments configuration associated with this org.
///
/// **OpenAPI type:** array of saferPaymentsResponse
#[cfg(not(feature = "sqlx"))]
#[serde(default)]
pub safer_payments: Option<Vec<serde_json::Value>>,
}
// =============================================================================
// TESTS
// =============================================================================
#[cfg(test)]
mod tests {
use super::*;
// ==================== Org Struct Tests ====================
#[test]
fn org_deserialize_full() {
let json = r#"{
"id": "t1_org_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",
"login": "t1_lgn_12345678901234567890125",
"name": "Test Organization",
"description": "An organization for testing",
"defaultFeeFromEntity": "t1_ent_12345678901234567890123"
}"#;
let org: Org = serde_json::from_str(json).unwrap();
assert_eq!(org.id.as_str(), "t1_org_12345678901234567890123");
assert_eq!(org.created, Some("2024-01-01 00:00:00.0000".to_string()));
assert_eq!(org.modified, Some("2024-01-02 23:59:59.9999".to_string()));
assert_eq!(org.creator.as_ref().map(|c| c.as_str()), Some("t1_lgn_12345678901234567890123"));
assert_eq!(org.modifier.as_ref().map(|m| m.as_str()), Some("t1_lgn_12345678901234567890124"));
assert_eq!(org.login.as_ref().map(|l| l.as_str()), Some("t1_lgn_12345678901234567890125"));
assert_eq!(org.name, Some("Test Organization".to_string()));
assert_eq!(org.description, Some("An organization for testing".to_string()));
assert_eq!(org.default_fee_from_entity, Some("t1_ent_12345678901234567890123".to_string()));
}
#[test]
fn org_deserialize_minimal() {
let json = r#"{"id": "t1_org_12345678901234567890123"}"#;
let org: Org = serde_json::from_str(json).unwrap();
assert_eq!(org.id.as_str(), "t1_org_12345678901234567890123");
assert!(org.created.is_none());
assert!(org.modified.is_none());
assert!(org.creator.is_none());
assert!(org.modifier.is_none());
assert!(org.login.is_none());
assert!(org.name.is_none());
assert!(org.description.is_none());
assert!(org.default_fee_from_entity.is_none());
}
#[test]
#[cfg(not(feature = "sqlx"))]
fn org_with_nested_relations() {
let json = r#"{
"id": "t1_org_12345678901234567890123",
"fees": [{"id": "t1_fee_12345678901234567890123"}],
"reserves": [{"id": "t1_rsv_12345678901234567890123"}],
"billings": []
}"#;
let org: Org = serde_json::from_str(json).unwrap();
assert!(org.fees.is_some());
assert_eq!(org.fees.as_ref().unwrap().len(), 1);
assert!(org.reserves.is_some());
assert_eq!(org.reserves.as_ref().unwrap().len(), 1);
assert!(org.billings.is_some());
assert_eq!(org.billings.as_ref().unwrap().len(), 0);
}
#[test]
fn org_serialize_roundtrip() {
let json = r#"{
"id": "t1_org_12345678901234567890123",
"name": "Test Org",
"description": "Test description"
}"#;
let org: Org = serde_json::from_str(json).unwrap();
let serialized = serde_json::to_string(&org).unwrap();
let deserialized: Org = serde_json::from_str(&serialized).unwrap();
assert_eq!(org.id, deserialized.id);
assert_eq!(org.name, deserialized.name);
assert_eq!(org.description, deserialized.description);
}
}