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

/// Common Akahu error types as per the documentation.
///
/// [<https://developers.akahu.nz/docs/response-formatting#common-error-messages>]
#[derive(Debug, thiserror::Error)]
pub enum AkahuError {
    // API-level errors (from Akahu responses)
    /// Bad request - invalid request parameters
    #[error("Bad request: {message}")]
    BadRequest {
        /// Error message from the API
        message: String,
        /// HTTP status code (400)
        status: u16,
    },

    /// Unauthorized - invalid or revoked authentication credentials
    #[error("Unauthorized: {message}")]
    Unauthorized {
        /// Error message from the API
        message: String,
    },

    /// Forbidden - insufficient permissions or missing required headers
    #[error("Forbidden: {message}")]
    Forbidden {
        /// Error message from the API
        message: String,
    },

    /// Not found - resource doesn't exist or is inaccessible
    #[error("Not found: {message}")]
    NotFound {
        /// Error message from the API
        message: String,
    },

    /// Rate limited - too many requests
    #[error("Rate limited: {message}")]
    RateLimited {
        /// Error message from the API
        message: String,
    },

    /// Internal server error - system-level failure
    #[error("Internal server error: {message}")]
    InternalServerError {
        /// Error message from the API
        message: String,
    },

    /// Generic API error with status code and message
    #[error("API error {status}: {message}")]
    ApiError {
        /// HTTP status code
        status: u16,
        /// Error message from the API
        message: String,
    },

    // Client-level errors
    /// Network error from reqwest
    #[error("Network error: {0}")]
    Network(#[from] reqwest::Error),

    /// Invalid header value
    #[error("Invalid header value: {0}")]
    InvalidHeaderValue(#[from] reqwest::header::InvalidHeaderValue),

    /// URL parse error
    #[error("URL parse error: {0}")]
    UrlParse(#[from] url::ParseError),

    /// JSON deserialization error
    #[error("JSON deserialization error: {error}{}", .source_string.as_ref().map(|s| format!(" - {}", s)).unwrap_or_default())]
    JsonDeserialization {
        /// The deserialisation error that was generated.
        error: serde_json::Error,
        /// The string that was originally being deserialized, if available.
        source_string: Option<String>,
    },

    /// Missing app secret - call with_app_secret() first for app-scoped endpoints
    #[error("Missing app secret - call with_app_secret() first")]
    MissingAppSecret,

    // OAuth-specific errors
    /// OAuth error response (follows OAuth2 spec)
    #[error("OAuth error: {error}{}", .error_description.as_ref().map(|d| format!(" - {}", d)).unwrap_or_default())]
    OAuth {
        /// OAuth error code (e.g., "invalid_grant")
        error: String,
        /// Optional human-readable error description
        error_description: Option<String>,
    },
}

/// Convenience type alias for Results using AkahuError
pub type AkahuResult<T> = std::result::Result<T, AkahuError>;