octopust 0.2.0

A high-performance, idiomatic Rust client for the Octopus Energy API.
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

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Serialize, Deserialize)]
pub struct ProductsResponse {
    pub count: u32,
    pub next: Option<String>,
    pub previous: Option<String>,
    pub results: Vec<Product>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct Product {
    pub direction: String,
    pub code: String,
    pub full_name: String,
    pub display_name: String,
    pub description: Option<String>,
    pub is_variable: bool,
    pub is_green: bool,
    pub is_tracker: bool,
    pub is_prepay: bool,
    pub is_business: bool,
    pub is_restricted: bool,
    pub term: Option<u32>,
    pub available_from: Option<String>,
    pub available_to: Option<String>,
    pub brand: Option<String>,
    pub links: Vec<Link>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct Link {
    pub href: String,
    pub method: String,
    pub rel: String,
}

/// Retrieve product details

#[derive(Debug, Serialize, Deserialize)]
pub struct ProductDetail {
    pub tariffs_active_at: Option<String>,
    pub code: String,
    pub full_name: String,
    pub display_name: String,
    pub description: Option<String>,
    pub is_variable: bool,
    pub is_green: bool,
    pub is_tracker: bool,
    pub is_prepay: bool,
    pub is_business: bool,
    pub is_restricted: bool,
    pub term: Option<u32>,
    pub available_from: Option<String>,
    pub available_to: Option<String>,
    pub brand: Option<String>,
    pub links: Vec<Link>,

    pub single_register_electricity_tariffs: Option<HashMap<String, ElectricityTariffType>>,
    pub dual_register_electricity_tariffs: Option<HashMap<String, ElectricityTariffType>>,
    pub single_register_gas_tariffs: Option<HashMap<String, GasTariffType>>,

    pub sample_quotes: Option<HashMap<String, QuoteType>>,
    pub sample_consumption: Option<SampleConsumption>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ElectricityTariffType {
    pub direct_debit_monthly: Option<ElectricityTariff>,
    pub direct_debit_quarterly: Option<ElectricityTariff>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GasTariffType {
    pub direct_debit_monthly: Option<GasTariff>,
    pub direct_debit_quarterly: Option<GasTariff>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ElectricityTariff {
    pub code: Option<String>,
    pub standard_unit_rate_exc_vat: Option<f64>,
    pub standard_unit_rate_inc_vat: Option<f64>,
    pub standing_charge_exc_vat: Option<f64>,
    pub standing_charge_inc_vat: Option<f64>,
    pub online_discount_exc_vat: Option<f64>,
    pub online_discount_inc_vat: Option<f64>,
    pub dual_fuel_discount_exc_vat: Option<f64>,
    pub dual_fuel_discount_inc_vat: Option<f64>,
    pub exit_fees_exc_vat: Option<f64>,
    pub exit_fees_inc_vat: Option<f64>,
    pub exit_fees_type: Option<String>,
    pub links: Option<Vec<Link>>,
}

pub type GasTariff = ElectricityTariff; // Gas and electricity tariffs have the same structure

#[derive(Debug, Serialize, Deserialize)]
pub struct QuoteType {
    pub direct_debit_monthly: Option<QuoteCategory>,
    pub direct_debit_quarterly: Option<QuoteCategory>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct QuoteCategory {
    pub electricity_single_rate: Option<Quote>,
    pub electricity_dual_rate: Option<Quote>,
    pub dual_fuel_single_rate: Option<Quote>,
    pub dual_fuel_dual_rate: Option<Quote>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct Quote {
    pub annual_cost_inc_vat: Option<f64>,
    pub annual_cost_exc_vat: Option<f64>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct SampleConsumption {
    pub electricity_single_rate: Option<ElectricitySingleRate>,
    pub electricity_dual_rate: Option<ElectricityDualRate>,
    pub dual_fuel_single_rate: Option<DualFuelSingleRate>,
    pub dual_fuel_dual_rate: Option<DualFuelDualRate>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ElectricitySingleRate {
    pub electricity_standard: Option<u32>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ElectricityDualRate {
    pub electricity_day: Option<u32>,
    pub electricity_night: Option<u32>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct DualFuelSingleRate {
    pub electricity_standard: Option<u32>,
    pub gas_standard: Option<u32>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct DualFuelDualRate {
    pub electricity_day: Option<u32>,
    pub electricity_night: Option<u32>,
    pub gas_standard: Option<u32>,
}

/// Tariff Charges - day, night, standard, standing, etc
#[derive(Debug, Deserialize)]
pub struct TariffCharge {
    pub value_exc_vat: f64,
    pub value_inc_vat: f64,
    pub valid_from: String,
    pub valid_to: Option<String>,
    pub payment_method: Option<String>,
}

#[derive(Debug, Deserialize)]
pub struct TariffChargesResponse {
    pub count: u32,
    pub next: Option<String>,
    pub previous: Option<String>,
    pub results: Vec<TariffCharge>,
}

/// Consumption
#[derive(Debug, Deserialize)]
pub struct ConsumptionReading {
    pub consumption: f64,
    pub interval_start: String,
    pub interval_end: String,
}

#[derive(Debug, Deserialize)]
pub struct ConsumptionResponse {
    pub count: u32,
    pub next: Option<String>,
    pub previous: Option<String>,
    pub results: Vec<ConsumptionReading>,
}

// Supply points
#[derive(Debug, Deserialize)]
pub struct GridSupplyPoint {
    pub group_id: String,
}

#[derive(Debug, Deserialize)]
pub struct GridSupplyPointsResponse {
    pub count: u32,
    pub next: Option<String>,
    pub previous: Option<String>,
    pub results: Vec<GridSupplyPoint>,
}

// Get electricity mpan
#[derive(Debug, Deserialize)]
pub struct MpanInfo {
    pub gsp: String,
    pub mpan: String,
    pub profile_class: u8,
}