vt3 0.7.3

VirusTotal REST API v3 (Public & Enterprise)
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

mod response;
use response::{ApiUsage, GroupMembers, GroupRoot, OverallQuotaRoot, UserRoot};

use crate::{
    utils::{http_delete, http_get, http_get_with_params},
    VtClient, VtResult,
};

impl VtClient {
    pub fn user_info(&self, id: &str) -> VtResult<UserRoot> {
        //! Retrieve user information.
        //!
        //! ## Example Usage
        //! ```rust
        //! use vt3::VtClient;
        //!
        //! let vt = VtClient::new("Your API Key");
        //! vt.user_info("user_id");
        //! ```
        let url = format!("{}/users/{}", self.endpoint, id);
        http_get(&self.api_key, &self.user_agent, &url)
    }

    pub fn delete_user(&self, id: &str) -> VtResult<UserRoot> {
        //! Delete a user.
        //!
        //! ## Example Usage
        //! ```rust
        //! use vt3::VtClient;
        //!
        //! let vt = VtClient::new("Your API Key");
        //! vt.delete_user("user_id");
        //! ```
        let url = format!("{}/users/{}", self.endpoint, id);
        http_delete(&self.api_key, &self.user_agent, &url)
    }

    pub fn api_usage(
        &self,
        id: &str,
        start_date: Option<&str>,
        end_date: Option<&str>,
    ) -> VtResult<ApiUsage> {
        //! Retrieve user's API usage.
        //!
        //! ## Example Usage
        //! ```rust
        //! use vt3::VtClient;
        //!
        //! let vt = VtClient::new("Your API Key");
        //!
        //! // start_date & end_date fomrat is: YYYYMMDD
        //! vt.api_usage("user_id", None, None);
        //! ```
        let url = format!("{}/users/{}/api_usage", self.endpoint, id);
        let mut query_params: Vec<(&str, &str)> = Vec::new();
        if let Some(s) = start_date {
            query_params.push(("start_date", s))
        }
        if let Some(e) = end_date {
            query_params.push(("end_date", e))
        }
        http_get_with_params(
            &self.api_key,
            &self.user_agent,
            &url,
            &query_params.as_slice(),
        )
    }

    pub fn overall_quotas(&self, id: &str) -> VtResult<OverallQuotaRoot> {
        //! User's overall quotas.
        //!
        //! ## Example Usage
        //! ```rust
        //! use vt3::VtClient;
        //!
        //! let vt = VtClient::new("Your API Key");
        //! vt.overall_quotas("user_id");
        //! ```
        let url = format!("{}/users/{}/overall_quotas", self.endpoint, id);
        http_get(&self.api_key, &self.user_agent, &url)
    }

    pub fn group_info(&self, id: &str) -> VtResult<GroupRoot> {
        //! Retrieve group information.
        //!
        //! ## Example Usage
        //! ```rust
        //! use vt3::VtClient;
        //!
        //! let vt = VtClient::new("Your API Key");
        //! vt.overall_quotas("user_id");
        //! ```
        let url = format!("{}/groups/{}", self.endpoint, id);
        http_get(&self.api_key, &self.user_agent, &url)
    }

    pub fn group_members(&self, id: &str) -> VtResult<GroupMembers> {
        //! Retrieve group members.
        //!
        //! ## Example Usage
        //! ```rust
        //! use vt3::VtClient;
        //!
        //! let vt = VtClient::new("Your API Key");
        //! vt.group_members("user_id");
        //! ```
        let url = format!("{}/groups/{}/relationships/users", self.endpoint, id);
        http_get(&self.api_key, &self.user_agent, &url)
    }

    pub fn group_api_usage(
        &self,
        id: &str,
        start_date: Option<&str>,
        end_date: Option<&str>,
    ) -> VtResult<ApiUsage> {
        //! Retrieve group's API usage.
        //!
        //! ## Example Usage
        //! ```rust
        //! use vt3::VtClient;
        //!
        //! let vt = VtClient::new("Your API Key");
        //!
        //! // start_date & end_date fomrat is: YYYYMMDD
        //! vt.group_api_usage("user_id", None, None);
        //! ```
        let url = format!("{}/groups/{}/api_usage", self.endpoint, id);
        let mut query_params: Vec<(&str, &str)> = Vec::new();
        if let Some(s) = start_date {
            query_params.push(("start_date", s))
        }
        if let Some(e) = end_date {
            query_params.push(("end_date", e))
        }
        http_get_with_params(
            &self.api_key,
            &self.user_agent,
            &url,
            &query_params.as_slice(),
        )
    }
}