akahu-client 0.1.1

A non-official Rust client library for the Akahu API, providing access to financial data aggregation services in New Zealand
Documentation 
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

//! Akahu API data models and response types.

mod account;
mod identity;
mod me;
mod transaction;

pub use account::*;
pub use identity::*;
pub use me::*;
pub use transaction::*;

use serde::{Deserialize, Serialize};

use crate::Cursor;

// TODO: could we combine all three of these response types into one generic type?

/// Standard error response structure from Akahu API
///
/// All API errors follow this format with a success flag and message field.
#[derive(Debug, Deserialize)]
pub struct ErrorResponse {
    /// Always false for error responses
    pub success: bool,
    /// Error message from the API
    pub message: String,
}

/// Standard API response wrapper for a single item.
///
/// Most Akahu API endpoints that return a single resource wrap the response
/// in this format with a `success` field and the actual data in the `item` field.
///
/// # Example JSON
/// ```json
/// {
///   "success": true,
///   "item": { ... }
/// }
/// ```
///
/// [<https://developers.akahu.nz/docs/response-formatting>]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)]
pub struct ItemResponse<T> {
    /// Indicates if the request was successful.
    pub success: bool,

    /// The resource data.
    pub item: T,
}

/// Standard API response wrapper for a list of items.
///
/// Most Akahu API endpoints that return a list of resources wrap the response
/// in this format with a `success` field and the actual data in the `items` array.
///
/// # Example JSON
/// ```json
/// {
///   "success": true,
///   "items": [...]
/// }
/// ```
///
/// [<https://developers.akahu.nz/docs/response-formatting>]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)]
pub struct ListResponse<T> {
    /// Indicates if the request was successful.
    pub success: bool,

    /// The list of resources.
    pub items: Vec<T>,
}

/// Standard API response wrapper for paginated items.
///
/// Used by endpoints that support cursor-based pagination, such as transaction listings.
/// The cursor object contains a `next` field that can be used to fetch the next page.
///
/// # Example JSON
/// ```json
/// {
///   "success": true,
///   "items": [...],
///   "cursor": {
///     "next": "cursor_token..."
///   }
/// }
/// ```
///
/// [<https://developers.akahu.nz/docs/response-formatting>]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)]
pub struct PaginatedResponse<T> {
    /// Indicates if the request was successful.
    pub success: bool,

    /// The list of resources for this page.
    pub items: Vec<T>,

    /// Cursor information for pagination.
    pub cursor: CursorObject,
}

/// Cursor for paginating through transaction results.
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)]
pub struct CursorObject {
    /// Cursor value to use for fetching the next page of results.
    pub next: Option<Cursor>,
}