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

//! User profile models for the Akahu API.

use serde::{Deserialize, Serialize};

use crate::UserId;

/// Represents the authenticated user's profile information.
///
/// This model contains basic information about the user who authorized your application.
/// The availability of certain fields (such as email) depends on whether your application
/// has been granted the appropriate scopes (e.g., `AKAHU` scope for email access).
///
/// [<https://developers.akahu.nz/reference/get_me>]
#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq)]
pub struct User {
    /// The unique identifier for the user in the Akahu system.
    ///
    /// [<https://developers.akahu.nz/reference/get_me>]
    #[serde(rename = "_id")]
    pub id: UserId,

    /// The timestamp when this user account was created.
    ///
    /// This represents when the user first registered with Akahu.
    ///
    /// [<https://developers.akahu.nz/reference/get_me>]
    pub created_at: chrono::DateTime<chrono::Utc>,

    /// The user's first name.
    ///
    /// This is the first name the user provided when registering with Akahu.
    ///
    /// [<https://developers.akahu.nz/reference/get_me>]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub first_name: Option<String>,

    /// The user's last name.
    ///
    /// This is the last name the user provided when registering with Akahu.
    ///
    /// [<https://developers.akahu.nz/reference/get_me>]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub last_name: Option<String>,

    /// The user's email address.
    ///
    /// This is the email address the user used to register their Akahu account.
    ///
    /// **Note:** This field is only visible if your application has been granted
    /// the `AKAHU` scope, which provides access to the user's profile information.
    ///
    /// [<https://developers.akahu.nz/reference/get_me>]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,

    /// The timestamp when the user granted access to your application.
    ///
    /// This represents when the user authorized your app through the OAuth flow.
    ///
    /// [<https://developers.akahu.nz/reference/get_me>]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub access_granted_at: Option<chrono::DateTime<chrono::Utc>>,
}