vynfi 1.8.0

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
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

use reqwest::Method;
use serde::Deserialize;

use crate::client::Client;
use crate::error::VynFiError;
use crate::types::*;

/// Template packs resource (VynFi API 4.1+, DS 3.2+, Team+).
pub struct TemplatePacks<'a> {
    client: &'a Client,
}

#[derive(Debug, Deserialize, Default)]
struct StringList {
    #[serde(default)]
    data: Vec<String>,
}

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

    pub async fn list(&self) -> Result<TemplatePackList, VynFiError> {
        self.client.request(Method::GET, "/v1/template-packs").await
    }

    pub async fn create(&self, req: &CreatePackRequest) -> Result<TemplatePack, VynFiError> {
        self.client
            .request_with_body(Method::POST, "/v1/template-packs", Some(req))
            .await
    }

    pub async fn categories(&self) -> Result<Vec<String>, VynFiError> {
        // Endpoint returns a bare JSON array; deserialise to Value first then
        // coerce to Vec<String>.
        let v: serde_json::Value = self
            .client
            .request(Method::GET, "/v1/template-packs/categories")
            .await?;
        Ok(match v {
            serde_json::Value::Array(xs) => xs
                .into_iter()
                .filter_map(|x| x.as_str().map(|s| s.to_owned()))
                .collect(),
            serde_json::Value::Object(map) => {
                let parsed: StringList =
                    serde_json::from_value(serde_json::Value::Object(map)).unwrap_or_default();
                parsed.data
            }
            _ => Vec::new(),
        })
    }

    pub async fn get(&self, pack_id: &str) -> Result<TemplatePack, VynFiError> {
        self.client
            .request(Method::GET, &format!("/v1/template-packs/{pack_id}"))
            .await
    }

    pub async fn update(
        &self,
        pack_id: &str,
        req: &UpdatePackRequest,
    ) -> Result<TemplatePack, VynFiError> {
        self.client
            .request_with_body(
                Method::PUT,
                &format!("/v1/template-packs/{pack_id}"),
                Some(req),
            )
            .await
    }

    pub async fn delete(&self, pack_id: &str) -> Result<DeletedResponse, VynFiError> {
        self.client
            .request(Method::DELETE, &format!("/v1/template-packs/{pack_id}"))
            .await
    }

    pub async fn validate(&self, pack_id: &str) -> Result<TemplatePackValidation, VynFiError> {
        self.client
            .request(
                Method::POST,
                &format!("/v1/template-packs/{pack_id}/validate"),
            )
            .await
    }

    pub async fn get_category(
        &self,
        pack_id: &str,
        category: &str,
    ) -> Result<TemplatePackCategoryContent, VynFiError> {
        self.client
            .request(
                Method::GET,
                &format!("/v1/template-packs/{pack_id}/categories/{category}"),
            )
            .await
    }

    pub async fn upsert_category(
        &self,
        pack_id: &str,
        category: &str,
        content_yaml: &str,
    ) -> Result<TemplatePackCategorySummary, VynFiError> {
        #[derive(serde::Serialize)]
        #[serde(rename_all = "camelCase")]
        struct Body<'a> {
            content_yaml: &'a str,
        }
        self.client
            .request_with_body(
                Method::PUT,
                &format!("/v1/template-packs/{pack_id}/categories/{category}"),
                Some(&Body { content_yaml }),
            )
            .await
    }

    pub async fn delete_category(
        &self,
        pack_id: &str,
        category: &str,
    ) -> Result<DeletedResponse, VynFiError> {
        self.client
            .request(
                Method::DELETE,
                &format!("/v1/template-packs/{pack_id}/categories/{category}"),
            )
            .await
    }

    pub async fn enrich_category(
        &self,
        pack_id: &str,
        req: &EnrichCategoryRequest,
    ) -> Result<TemplatePackEnrichResponse, VynFiError> {
        self.client
            .request_with_body(
                Method::POST,
                &format!("/v1/template-packs/{pack_id}/enrich"),
                Some(req),
            )
            .await
    }
}