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

use reqwest::Method;

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

/// Sessions resource — manage multi-period generation sessions.
pub struct Sessions<'a> {
    client: &'a Client,
}

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

    /// List all generation sessions.
    pub async fn list(&self) -> Result<Vec<GenerationSession>, VynFiError> {
        self.client.request(Method::GET, "/v1/sessions").await
    }

    /// Create a new multi-period generation session.
    pub async fn create(
        &self,
        req: &CreateSessionRequest,
    ) -> Result<GenerationSession, VynFiError> {
        self.client
            .request_with_body(Method::POST, "/v1/sessions", Some(req))
            .await
    }

    /// Add more periods to an existing session.
    pub async fn extend(
        &self,
        session_id: &str,
        req: &ExtendSessionRequest,
    ) -> Result<GenerationSession, VynFiError> {
        self.client
            .request_with_body(
                Method::POST,
                &format!("/v1/sessions/{}/extend", session_id),
                Some(req),
            )
            .await
    }

    /// Generate the next period of a session. Returns the session state with
    /// the new job's details.
    pub async fn generate_next(
        &self,
        session_id: &str,
    ) -> Result<GenerateSessionResponse, VynFiError> {
        self.client
            .request_with_body::<GenerateSessionResponse, ()>(
                Method::POST,
                &format!("/v1/sessions/{}/generate", session_id),
                None,
            )
            .await
    }
}