whmcs 0.1.0

Rust client for the WHMCS 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
150
151
152
153
154
155
156
157

use crate::{
    builder::WhmcsClient,
    error::WhmcsError,
    models::clients::{
        GetClientDetailsParams, GetClientDetailsResponse, GetClientGroupsResponse, GetClientParams,
        GetClientPasswordParams, GetClientPasswordResponse, GetClientsResponse,
    },
    resources::endpoint,
};

impl WhmcsClient {
    endpoint!(
        /// Obtain a vector of client groups
        ///
        /// Reference: https://developers.whmcs.com/api-reference/getclientgroups/
        get_client_groups,
        "GetClientGroups",
        GetClientGroupsResponse
    );
    endpoint!(
        #[deprecated(since = "0.1.0", note = "Deprecated in WHMCS 8.0.0")]
        /// Obtain the encrypted client password
        ///
        /// Reference: https://developers.whmcs.com/api-reference/getclientpassword/
        get_client_password,
        "GetClientPassword",
        GetClientPasswordParams,
        GetClientPasswordResponse
    );
    endpoint!(
        /// Obtain the Clients that match passed criteria
        ///
        /// Reference: https://developers.whmcs.com/api-reference/getclients/
        get_clients,
        "GetClients",
        GetClientParams,
        GetClientsResponse
    );
    endpoint!(
        /// Obtain the Clients Details for a specific client
        ///
        /// *Internal usage note:* this function returns the client information in the top level array. This information is deprecated and may be removed in a future version of WHMCS.
        ///
        /// Reference: https://developers.whmcs.com/api-reference/getclientsdetails/
        get_client_details,
        "GetClientsDetails",
        GetClientDetailsParams,
        GetClientDetailsResponse
    );
}

#[cfg(test)]
mod tests {
    use crate::{
        error::WhmcsError,
        models::clients::{
            ClientGroupId, ClientStatus, GetClientDetailsParams, GetClientParams,
            GetClientPasswordParams,
        },
        test::get_test_client,
    };

    #[ignore]
    #[tokio::test]
    async fn get_client_groups() {
        let client = get_test_client();
        let response = client.get_client_groups().await.unwrap();
        assert_eq!(response.total_results, 0);
        assert_eq!(response.groups.len(), 0);
    }

    #[ignore]
    #[tokio::test]
    async fn invalid_get_client_password() {
        let client = get_test_client();
        #[allow(deprecated)]
        let err = client
            .get_client_password(None)
            .await
            .expect_err("should be an error");
        assert!(matches!(err, WhmcsError::ApiError(_)));
    }

    #[ignore]
    #[tokio::test]
    async fn get_client_password() {
        let client = get_test_client();
        #[allow(deprecated)]
        let response = client
            .get_client_password(GetClientPasswordParams::default().client_id(1))
            .await
            .unwrap();
        assert!(response.password.starts_with("$2y$"));
    }

    #[ignore]
    #[tokio::test]
    async fn get_clients() {
        let client = get_test_client();
        let response = client.get_clients(None).await.unwrap();
        assert_ne!(response.total_results, 0);
        assert_eq!(response.number_returned, 25);
        assert_eq!(response.start_number, 0);
        assert_eq!(response.clients.len(), 25);
        assert_eq!(response.clients[0].group_id, ClientGroupId::new(0));
        assert_eq!(response.clients[0].status, ClientStatus::Inactive);
    }

    #[ignore]
    #[tokio::test]
    async fn get_no_clients() {
        let client = get_test_client();
        let response = client
            .get_clients(GetClientParams::default().search("nonexistentuser"))
            .await
            .unwrap();
        assert_eq!(response.total_results, 0);
        assert_eq!(response.number_returned, 0);
        assert_eq!(response.start_number, 0);
        assert_eq!(response.clients.len(), 0);
    }

    #[ignore]
    #[tokio::test]
    async fn get_single_client() {
        let client = get_test_client();
        let email = std::env::var("EMAIL").unwrap();
        let response = client
            .get_clients(GetClientParams::default().search(email.clone()))
            .await
            .unwrap();
        assert_ne!(response.total_results, 0);
        assert_eq!(response.number_returned, 1);
        assert_eq!(response.start_number, 0);
        assert_eq!(response.clients.len(), 1);
        assert_eq!(response.clients[0].group_id, ClientGroupId::new(0));
        assert_eq!(response.clients[0].status, ClientStatus::Active);
        assert_eq!(response.clients[0].email, email);
    }

    #[ignore]
    #[tokio::test]
    async fn get_client_details() {
        let client = get_test_client();
        let email = std::env::var("EMAIL").unwrap();
        let response = client
            .get_client_details(GetClientDetailsParams::default().email(email.clone()))
            .await
            .unwrap();

        assert_eq!(response.client.email, email);
        assert_eq!(response.client.users.len(), 1);
        assert_eq!(response.client.users[0].email, email);
        assert!(response.client.users[0].is_owner);
        assert!(response.stats.is_none());
    }
}