eskom_se_push-api 0.2.0

API Bindings to the Eskom-se-Push 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

use derive_builder::Builder;
use serde::Deserialize;
use serde::Serialize;

use crate::errors::HttpError;
use crate::traits::Endpoint;
#[cfg(any(feature = "async", doc))]
use crate::traits::EndpointAsync;

#[derive(Default, Builder, Debug)]
#[builder(setter(into))]
pub struct AreaSearchURL {
  search_term: String,
}

impl Endpoint for AreaSearchURL {
  type Output = AreaSearch;

  fn endpoint(&self) -> std::borrow::Cow<'static, str> {
    std::borrow::Cow::Borrowed("https://developer.sepush.co.za/business/2.0/areas_search")
  }

  fn url(&self) -> Result<url::Url, crate::errors::HttpError> {
    let mut u = url::Url::parse(&self.endpoint()).unwrap();
    if self.search_term.trim().is_empty() {
      Err(HttpError::SearchTextNotSet)
    } else {
      u.set_query(Some(format!("text={}", self.search_term).as_str()));
      Ok(u)
    }
  }
}

#[cfg(any(feature = "async", doc))]
impl EndpointAsync for AreaSearchURL {}

#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AreaSearch {
  /// Vec of areas
  pub areas: Vec<Area>,
}

#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Area {
  /// ID of the area. To be used when querying for the related info.
  pub id: String,
  /// Name of the area.
  pub name: String,
  /// Region the area is in.
  pub region: String,
}