splitwise 0.3.0

Splitwise SDK for Rust
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
111
112
113
114
115
116
117
118
119

use chrono::Utc;
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub(crate) struct NotificationsWrapper {
    pub notifications: Vec<Notification>,
}

/// Notification of activity on the user's account.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Notification {
    /// Notification ID.
    pub id: Option<i64>,

    /// Notification type.
    #[serde(rename = "type")]
    pub notification_type: Option<NotificationType>,

    /// Timestamp of when the notification was created.
    pub created_at: Option<chrono::DateTime<Utc>>,

    /// ID of the user who created the notification.
    pub created_by: Option<i64>,

    /// Notification source.
    pub source: Option<NotificationSource>,

    /// URL of the notification image.
    pub image_url: Option<String>,

    /// Shape of the image. One of:
    /// - `square`
    /// - `circle`
    pub image_shape: Option<String>,

    /// Notification content.
    pub content: Option<String>,
}

/// Notification source.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct NotificationSource {
    /// Notification source type.
    #[serde(rename = "type")]
    pub source_type: Option<String>,

    /// Notification source ID.
    pub id: Option<i64>,

    /// Notification source URL.
    pub url: Option<String>,
}

/// Indicates what the notification is about.
///
/// **Note:** Notification types may be added in the future without warning.
#[derive(Debug, Clone, PartialEq, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
pub enum NotificationType {
    /// Expense added.
    ExpenseAdded,

    /// Expense updated.
    ExpenseUpdated,

    /// Expense deleted.
    ExpenseDeleted,

    /// Comment added.
    CommentAdded,

    /// Added to group.
    AddedToGroup,

    /// Removed from group.
    RemovedFromGroup,

    /// Group deleted.
    GroupDeleted,

    /// Group settings changed.
    GroupSettingsChanged,

    /// Added as friend.
    AddedAsFriend,

    /// Removed as friend.
    RemovedAsFriend,

    /// News. A URL should be included.
    News,

    /// Debt simplification.
    DebtSimplification,

    /// Group restored.
    GroupUndeleted,

    /// Expense restored.
    ExpenseUndeleted,

    /// Group currency conversion.
    GroupCurrencyConversion,

    /// Friend currency conversion.
    FriendCurrencyConversion,
}

/// Splitwise `get_notifications` request.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct GetNotificationsRequest {
    /// If provided, returns only notifications after this time.
    pub updated_after: Option<chrono::DateTime<Utc>>,

    /// Omit (or provide 0) to get the maximum number of notifications.
    /// Default: `0`.
    pub limit: Option<i64>,
}