eve_esi 0.4.9

Thread-safe, asynchronous client for EVE Online's ESI & OAuth2
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

//! # EVE ESI Market Models
//!
//! Provides models related to market endpoints for EVE Online's ESI API.
//!
//! ## ESI Documentation
//! - <https://developers.eveonline.com/api-explorer>
//!
//! ## Models
//! - [`CharacterMarketOrder`]: Details for a character's market order
//! - [`CorporationMarketOrder`]: Details for a corporation's market order
//! - [`MarketItemGroupInformation`]: Information regarding a specific market group
//! - [`MarketItemPrices`]: The average & adjusted market prices of an item
//! - [`StructureMarketOrder`]: Details for a market order placed within a structure
//! - [`MarketItemRegionStatistics`]: An entry for the market statistics of an item within a specific region on a given date

use chrono::{DateTime, NaiveDate, Utc};
use serde::{Deserialize, Serialize};

use crate::model::enums::market::{HistoricalMarketOrderState, MarketOrderRange};

/// Details for a character's market order
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/CharactersCharacterIdOrdersGet>
/// - <https://developers.eveonline.com/api-explorer#/schemas/CharactersCharacterIdOrdersHistoryGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct CharacterMarketOrder {
    /// Number of days for which the order is valid
    /// starting from the issued date.
    ///
    /// An order expires at time issued + duration
    pub duration: i64,
    /// For buy orders, the amount of ISK in escrow
    pub escrow: Option<f64>,
    /// True if the order is a buy order
    #[serde(default)]
    pub is_buy_order: bool,
    /// Indicates whether or not order was placed on behalf of a corporation
    pub is_corporation: bool,
    /// Date and time when the order was issued
    pub issued: DateTime<Utc>,
    /// ID of the location where order was placed
    pub location_id: i64,
    /// For buy orders, the minimum quantity that will be accepted in a matching sell order
    pub min_volume: Option<i64>,
    /// Unique ID of the order
    pub order_id: i64,
    /// The cost per unit for this order
    pub price: f64,
    /// The range of the order
    pub range: MarketOrderRange,
    /// ID of the region where the order was placed
    pub region_id: i64,
    /// If it is a historical market order, indicates whether it was cancelled or expired
    pub state: Option<HistoricalMarketOrderState>,
    /// The type ID of the item in the order
    pub type_id: i64,
    /// Remaining quantity of items still for sale or buy
    pub volume_remain: i64,
    /// Quantity of items for sale or to buy when the order was placed
    pub volume_total: i64,
}

/// Details for a corporation's market order
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/CorporationsCorporationIdOrdersGet>
/// - <https://developers.eveonline.com/api-explorer#/schemas/CorporationsCorporationIdOrdersHistoryGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct CorporationMarketOrder {
    /// Number of days for which the order is valid
    /// starting from the issued date.
    ///
    /// An order expires at time issued + duration
    pub duration: i64,
    /// For buy orders, the amount of ISK in escrow
    pub escrow: Option<f64>,
    /// True if the order is a buy order
    #[serde(default)]
    pub is_buy_order: bool,
    /// Date and time when the order was issued
    pub issued: DateTime<Utc>,
    /// Character ID of who issued the market order
    pub issued_by: i64,
    /// ID of the location where order was placed
    pub location_id: i64,
    /// For buy orders, the minimum quantity that will be accepted in a matching sell order
    pub min_volume: Option<i64>,
    /// Unique ID of the order
    pub order_id: i64,
    /// The cost per unit for this order
    pub price: f64,
    /// The range of the order
    pub range: MarketOrderRange,
    /// ID of the region where the order was placed
    pub region_id: i64,
    /// If it is a historical market order, indicates whether it was cancelled or expired
    pub state: Option<HistoricalMarketOrderState>,
    /// The type ID of the item in the order
    pub type_id: i64,
    /// Remaining quantity of items still for sale or buy
    pub volume_remain: i64,
    /// Quantity of items for sale or to buy when the order was placed
    pub volume_total: i64,
}

/// Information regarding a specific market group
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/MarketsGroupsMarketGroupIdGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct MarketItemGroupInformation {
    /// The description of the market item group
    pub description: String,
    /// The name of the market item group
    pub name: String,
    /// The ID of the market item group
    pub market_group_id: i64,
    /// The ID of the parent market item group if applicable
    pub parent_group_id: Option<i64>,
    /// The type IDs of the items within the group
    pub types: Vec<i64>,
}

/// The average & adjusted market prices of an item
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/MarketsPricesGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct MarketItemPrices {
    /// The estimated price of what the item actually sells for on the market
    pub adjusted_price: Option<f64>,
    /// The average price of the item on the market
    pub average_price: Option<f64>,
    /// The type ID of the item on the market
    pub type_id: i64,
}

/// Details for a market order placed within a structure
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/MarketsStructuresStructureIdGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct StructureMarketOrder {
    /// Number of days for which the order is valid
    /// starting from the issued date.
    ///
    /// An order expires at time issued + duration
    pub duration: i64,
    /// True if the order is a buy order
    #[serde(default)]
    pub is_buy_order: bool,
    /// Date and time when the order was issued
    pub issued: DateTime<Utc>,
    /// ID of the location where order was placed
    pub location_id: i64,
    /// For buy orders, the minimum quantity that will be accepted in a matching sell order
    pub min_volume: Option<i64>,
    /// Unique ID of the order
    pub order_id: i64,
    /// The cost per unit for this order
    pub price: f64,
    /// The range of the order
    pub range: MarketOrderRange,
    /// The type ID of the item in the order
    pub type_id: i64,
    /// Remaining quantity of items still for sale or buy
    pub volume_remain: i64,
    /// Quantity of items for sale or to buy when the order was placed
    pub volume_total: i64,
}

/// An entry for the market statistics of an item within a specific region on a given date
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/MarketsRegionIdHistoryGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct MarketItemRegionStatistics {
    /// The average price of the item in this entry
    pub average: f64,
    /// The YYYY-MM-DD of this statistic entry
    pub date: NaiveDate,
    /// The highest price the item sold for in this entry
    pub highest: f64,
    /// The lowest price the item sold for in this enry
    pub lowest: f64,
    /// Total numbers of orders that occurred for this entry
    pub order_count: i64,
    /// The volume of the item traded for this entry
    pub volume: i64,
}

/// Entry for a market order placed when requesting regional market orders
///
/// # Documentation
/// - <https://developers.eveonline.com/api-explorer#/schemas/MarketsRegionIdOrdersGet>
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct MarketRegionOrder {
    /// Number of days for which the order is valid
    /// starting from the issued date.
    ///
    /// An order expires at time issued + duration
    pub duration: i64,
    /// True if the order is a buy order
    #[serde(default)]
    pub is_buy_order: bool,
    /// Date and time when the order was issued
    pub issued: DateTime<Utc>,
    /// ID of the location where order was placed
    pub location_id: i64,
    /// For buy orders, the minimum quantity that will be accepted in a matching sell order
    pub min_volume: i64,
    /// Unique ID of the order
    pub order_id: i64,
    /// The cost per unit for this order
    pub price: f64,
    /// The range of the order
    pub range: MarketOrderRange,
    /// ID of the solar system where the order was placed
    pub system_id: i64,
    /// The type ID of the item in the order
    pub type_id: i64,
    /// Remaining quantity of items still for sale or buy
    pub volume_remain: i64,
    /// Quantity of items for sale or to buy when the order was placed
    pub volume_total: i64,
}