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

use reqwest::Method;

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

/// Webhooks resource — create, list, update, delete, and test webhooks.
pub struct Webhooks<'a> {
    client: &'a Client,
}

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

    /// Create a new webhook. The response includes the signing secret — store
    /// it securely, as it cannot be retrieved again.
    pub async fn create(&self, req: &CreateWebhookRequest) -> Result<WebhookCreated, VynFiError> {
        self.client
            .request_with_body(Method::POST, "/v1/webhooks", Some(req))
            .await
    }

    /// List all webhooks for the current account.
    pub async fn list(&self) -> Result<Vec<Webhook>, VynFiError> {
        let value: serde_json::Value = self.client.request(Method::GET, "/v1/webhooks").await?;
        extract_list(value)
    }

    /// Get a single webhook by ID, including recent delivery history.
    pub async fn get(&self, webhook_id: &str) -> Result<WebhookDetail, VynFiError> {
        self.client
            .request(Method::GET, &format!("/v1/webhooks/{}", webhook_id))
            .await
    }

    /// Update a webhook's URL, events, or status.
    pub async fn update(
        &self,
        webhook_id: &str,
        req: &UpdateWebhookRequest,
    ) -> Result<Webhook, VynFiError> {
        self.client
            .request_with_body(
                Method::PATCH,
                &format!("/v1/webhooks/{}", webhook_id),
                Some(req),
            )
            .await
    }

    /// Delete a webhook. This action is irreversible.
    pub async fn delete(&self, webhook_id: &str) -> Result<(), VynFiError> {
        self.client
            .request::<()>(Method::DELETE, &format!("/v1/webhooks/{}", webhook_id))
            .await
    }

    /// Send a test event to the webhook.
    pub async fn test(&self, webhook_id: &str) -> Result<serde_json::Value, VynFiError> {
        self.client
            .request_with_body::<serde_json::Value, ()>(
                Method::POST,
                &format!("/v1/webhooks/{}/test", webhook_id),
                None,
            )
            .await
    }
}