vynco 2.4.1

Rust SDK for the VynCo Swiss Corporate Intelligence 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

use reqwest::Method;

use crate::client::Client;
use crate::error::Result;
use crate::response::{Response, ResponseMeta};
use crate::types::*;

pub struct Changes<'a> {
    client: &'a Client,
}

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

    pub async fn list(
        &self,
        params: &ChangeListParams,
    ) -> Result<Response<PagedResponse<CompanyChange>>> {
        let mut query: Vec<(&str, String)> = Vec::new();
        if let Some(ref t) = params.change_type {
            query.push(("type", t.clone()));
        }
        if let Some(ref s) = params.since {
            query.push(("since", s.clone()));
        }
        if let Some(ref u) = params.until {
            query.push(("until", u.clone()));
        }
        if let Some(ref cs) = params.company_search {
            query.push(("companySearch", cs.clone()));
        }
        if let Some(p) = params.page {
            query.push(("page", p.to_string()));
        }
        if let Some(ps) = params.page_size {
            query.push(("pageSize", ps.to_string()));
        }
        if query.is_empty() {
            self.client.request(Method::GET, "/v1/changes").await
        } else {
            self.client
                .request_with_params(Method::GET, "/v1/changes", &query)
                .await
        }
    }

    pub async fn by_company(&self, uid: &str) -> Result<Response<Vec<CompanyChange>>> {
        self.client
            .request(Method::GET, &format!("/v1/changes/{uid}"))
            .await
    }

    pub async fn statistics(&self) -> Result<Response<ChangeStatistics>> {
        self.client
            .request(Method::GET, "/v1/changes/statistics")
            .await
    }

    /// Mark a change as reviewed (compliance workflow).
    pub async fn review(&self, id: &str) -> Result<ResponseMeta> {
        self.client
            .request_empty(Method::PUT, &format!("/v1/changes/{id}/review"))
            .await
    }

    /// Get a field-level diff for a company between two dates.
    pub async fn diff(
        &self,
        uid: &str,
        since: &str,
        until: Option<&str>,
    ) -> Result<Response<CompanyDiffResponse>> {
        let mut query: Vec<(&str, String)> = vec![("since", since.to_string())];
        if let Some(u) = until {
            query.push(("until", u.to_string()));
        }
        self.client
            .request_with_params(Method::GET, &format!("/v1/companies/{uid}/diff"), &query)
            .await
    }
}

#[cfg(test)]
mod tests {
    use crate::Client;

    #[tokio::test]
    async fn test_changes_statistics() {
        let mut server = mockito::Server::new_async().await;
        let mock = server
            .mock("GET", "/v1/changes/statistics")
            .with_status(200)
            .with_header("content-type", "application/json")
            .with_body(r#"{"totalChanges":12345,"changesThisWeek":234,"changesThisMonth":1050,"byType":{"name_change":500,"auditor_change":300}}"#)
            .create_async()
            .await;
        let client = Client::builder("vc_test_key")
            .base_url(server.url())
            .build()
            .unwrap();
        let resp = client.changes().statistics().await.unwrap();
        assert_eq!(resp.data.total_changes, 12345);
        assert_eq!(resp.data.changes_this_week, 234);
        mock.assert_async().await;
    }
}