vynfi 0.2.1

Rust SDK for the VynFi synthetic financial data 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

use reqwest::Method;

use crate::client::{extract_list, Client};
use crate::error::VynFiError;
use crate::types::*;

/// Catalog resource — browse sectors, tables, and fingerprint profiles.
pub struct Catalog<'a> {
    client: &'a Client,
}

impl<'a> Catalog<'a> {
    pub(crate) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// List all available sectors (without full table definitions).
    pub async fn list_sectors(&self) -> Result<Vec<SectorSummary>, VynFiError> {
        let value: serde_json::Value = self.client.request(Method::GET, "/v1/sectors").await?;
        extract_list(value)
    }

    /// Get a single sector by slug, including its full table definitions.
    pub async fn get_sector(&self, slug: &str) -> Result<Sector, VynFiError> {
        self.client
            .request(Method::GET, &format!("/v1/sectors/{}", slug))
            .await
    }

    /// List catalog items, optionally filtered by sector or search term.
    pub async fn list(
        &self,
        sector: Option<&str>,
        search: Option<&str>,
    ) -> Result<Vec<CatalogItem>, VynFiError> {
        let mut params: Vec<(&str, String)> = Vec::new();
        if let Some(s) = sector {
            params.push(("sector", s.to_string()));
        }
        if let Some(q) = search {
            params.push(("search", q.to_string()));
        }

        let value: serde_json::Value = if params.is_empty() {
            self.client.request(Method::GET, "/v1/catalog").await?
        } else {
            self.client
                .request_with_params(Method::GET, "/v1/catalog", &params)
                .await?
        };
        extract_list(value)
    }

    /// Get a fingerprint profile for a specific sector and profile slug.
    pub async fn get_fingerprint(
        &self,
        sector: &str,
        profile: &str,
    ) -> Result<Fingerprint, VynFiError> {
        self.client
            .request(Method::GET, &format!("/v1/catalog/{}/{}", sector, profile))
            .await
    }
}