provident 0.3.1

Unofficial client for the Provident (MeterConnex) utility metering portal: meters, usage history, and reports
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

// SPDX-License-Identifier: GPL-3.0-only

use crate::http::Request;
use crate::models::secure::account_info::get_key::{self, GetKeyRequest, GetKeyResponse};

use super::Account;
use crate::{Error, Result};

impl Account {
    /// The account's API key (`GetKey`). The portal requires re-entering the account password.
    ///
    /// # Errors
    /// [`Error::PasswordRejected`] when the server refuses the password (it still answers 200).
    ///
    /// A wrong password counts as a failed sign-in on the account: several in a short time
    /// briefly lock it out (logins fail), and overlapping ones can fail with HTTP 500 when the
    /// portal's database deadlocks recording them.
    #[maybe_async::maybe_async]
    pub async fn api_key(&self, password: &str) -> Result<String> {
        let body = GetKeyRequest {
            password: password.to_owned(),
        };
        let request = Request::page_method(get_key::METHOD, get_key::PATH)
            .json(&body)?
            .build();
        let result = self
            .http
            .send::<GetKeyResponse>(request)
            .await?
            .into_inner();
        match result.api_key {
            Some(key) if !result.error => Ok(key),
            _ => Err(Error::PasswordRejected {
                message: result.msg,
            }),
        }
    }
}