nordnet-model 0.1.0

Pure data types and crypto for the Nordnet External API v2 (no I/O).
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

//! Models for the `news` resource group.
//!
//! Derived from the Nordnet `NewsArticle` and `NewsSource` schemas.
//!
//!
//! ## Doc notes
//!
//! - `news_id` and `source_id` have local `NewsId` / `NewsSourceId`
//!   newtypes here (rather than under `crate::ids`).
//! - The `instruments` field on `NewsArticle` is documented as
//!   `< integer > array` (no `(int64)` qualifier) while `instrument_id`
//!   elsewhere in the docs is `integer(int64)`. We keep
//!   `Vec<InstrumentId>` here on the basis that these are the same
//!   identifier.
//! - `timestamp` (`integer(int64)`) is documented as "milliseconds since
//!   January 1st 1970 00:00:00 UTC". Kept as a plain `i64`.

use crate::ids::{InstrumentId, MarketId};
use serde::{Deserialize, Serialize};

/// External unique news article ID.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(transparent)]
pub struct NewsId(pub i64);

impl std::fmt::Display for NewsId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Display::fmt(&self.0, f)
    }
}

impl From<i64> for NewsId {
    fn from(v: i64) -> Self {
        Self(v)
    }
}

impl From<NewsId> for i64 {
    fn from(v: NewsId) -> Self {
        v.0
    }
}

/// Nordnet unique news source ID.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, PartialOrd, Ord, Serialize, Deserialize)]
#[serde(transparent)]
pub struct NewsSourceId(pub i64);

impl std::fmt::Display for NewsSourceId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Display::fmt(&self.0, f)
    }
}

impl From<i64> for NewsSourceId {
    fn from(v: i64) -> Self {
        Self(v)
    }
}

impl From<NewsSourceId> for i64 {
    fn from(v: NewsSourceId) -> Self {
        v.0
    }
}

/// A news article as returned by `GET /news/{item_id}`.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct NewsArticle {
    /// Article body. Optional per schema.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    /// Article author. Optional per schema.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub byline: Option<String>,
    /// Article headline.
    pub headline: String,
    /// List of instrument IDs affected by article. Optional per schema.
    ///
    /// Doc note: the schema lists `< integer > array` here without the
    /// `(int64)` qualifier used elsewhere for `instrument_id`. We treat
    /// the elements as `InstrumentId` (the same identifier semantics).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub instruments: Option<Vec<InstrumentId>>,
    /// List of ISINs affected by the article. Optional per schema.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub isin_codes: Option<Vec<String>>,
    /// News language.
    pub lang: String,
    /// Whether the article is in markdown format.
    pub markdown_format: bool,
    /// List of market IDs affected by the article. Optional per schema.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub markets: Option<Vec<MarketId>>,
    /// External unique news ID.
    pub news_id: NewsId,
    /// News type. Valid values: `NEWS`, `ANALYSIS`, `PRESS_RELEASE`,
    /// `MARKET_COMMENTARY`, `PM`, `PMVECKAN`, `MARKET_NEWS`,
    /// `VOLATILITY_HALT`, `TRADING_HALT`, `TRADING_EVENT`, `TOP10`.
    pub news_type: String,
    /// List of sectors affected by the article. Optional per schema.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub sectors: Option<Vec<String>>,
    /// Nordnet unique news source ID.
    pub source_id: NewsSourceId,
    /// Article summary. Optional per schema.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,
    /// Publication date.
    ///
    /// Doc note: documented as milliseconds since 1970-01-01 00:00:00 UTC.
    /// Kept as `i64` because no epoch-millis `Timestamp` newtype exists
    /// under `crate::models::shared` (matches the precedent in
    /// `models/main_search.rs`).
    pub timestamp: i64,
    /// Exists for backwards compatibility. Always set to `NEWS`.
    ///
    /// Renamed to `r#type` because `type` is a Rust keyword; the raw
    /// identifier syntax keeps the JSON field name visible at the use site.
    #[serde(rename = "type")]
    pub r#type: String,
    /// Article version. Plain `i64` — not an identifier.
    pub version: i64,
}

/// A news source as returned by `GET /news_sources`.
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Eq)]
pub struct NewsSource {
    /// List containing the country codes affected by the news source.
    /// Optional per schema.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub countries: Option<Vec<String>>,
    /// Access level. Valid values: `DELAYED` (15-minute delayed news),
    /// `REALTIME` (real-time news), `FLASH` (flash news; implies real-time
    /// access for ordinary news).
    pub level: String,
    /// News source name.
    pub name: String,
    /// Nordnet unique news source ID.
    pub source_id: NewsSourceId,
}