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

use std::collections::HashMap;

use serde::{Deserialize, Serialize};

use crate::model::{expenses::Expense, shared::Image};

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub(crate) struct CurrenciesWrapper {
    pub currencies: Vec<Currency>,
}

/// Currency supported by Splitwise.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Currency {
    /// Mostly ISO 4217 currency codes, along with colloquial codes such as
    /// "BTC".
    pub currency_code: Option<String>,

    /// Currency unit symbol.
    pub unit: Option<String>,
}

#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub(crate) struct CategoriesWrapper {
    pub categories: Vec<Category>,
}

/// Category for expenses.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Category {
    /// Category ID.
    pub id: Option<i64>,

    /// Category name.
    pub name: Option<String>,

    /// Category icon.
    pub icon: Option<String>,

    /// Category icon types.
    pub icon_types: Option<HashMap<String, Image>>,

    /// Subcategories.
    pub subcategories: Option<Vec<Category>>,
}

/// Splitwise `parse_sentence` request.
#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ParseSentenceRequest {
    /// A natural language sentence describing an expense.
    pub input: String,

    /// User ID.
    pub friend_id: Option<i64>,

    /// Group ID.
    pub group_id: Option<i64>,

    /// If true, the resulting expense will be saved if valid.
    pub autosave: bool,
}

/// Splitwise `parse_sentence` response.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct ParseSentenceResponse {
    /// Expense object parsed from the sentence input.
    pub expense: Option<Expense>,

    /// Whether the parsed input was a valid expense.
    pub valid: Option<bool>,

    /// Confidence value for the parsed expense.
    pub confidence: Option<f64>,

    /// Error that occurred during this request.
    pub error: Option<String>,
}