polyio 0.13.0

A create for interacting with the Polygon API at polygon.io.
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

// Copyright (C) 2020-2022 Daniel Mueller <deso@posteo.net>
// SPDX-License-Identifier: GPL-3.0-or-later

use std::collections::BTreeMap;

use serde::Deserialize;

use crate::api::response::Response;
use crate::Str;


/// A struct representing the ticker types.
///
/// Please note that not all fields available in a request are
/// represented here.
#[derive(Clone, Debug, Deserialize, PartialEq)]
pub struct TickerTypes {
  /// A mapping from ticker types to descriptions.
  #[serde(rename = "types")]
  pub types: BTreeMap<String, String>,
  /// A mapping from index types to descriptions.
  #[serde(rename = "indexTypes")]
  pub index_types: BTreeMap<String, String>,
}

Endpoint! {
  /// The representation of a GET request to the `/v2/reference/types`
  /// endpoint.
  pub Get(()),
  Ok => Response<TickerTypes>, [
    /// The ticker types were retrieved successfully.
    /* 200 */ OK,
  ],
  Err => GetError, []

  fn path(_input: &Self::Input) -> Str {
    "/v2/reference/types".into()
  }
}


#[cfg(not(target_arch = "wasm32"))]
#[cfg(test)]
mod tests {
  use super::*;

  use test_log::test;

  use crate::Client;

  #[test(tokio::test)]
  async fn request_ticker_types() {
    let client = Client::from_env().unwrap();
    let types = client.issue::<Get>(()).await.unwrap();

    println!("{:?}", types);
  }
}