veryfi 1.0.0

Module for communicating with the Veryfi OCR 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 crate::client::Client;
use std::time::Duration;

/// Create a client with default api key (v8).
/// # Arguments
///
/// * `client_id` - Client id provided by Veryfi.
/// * `client_secret` - Client secret provided by Veryfi.
/// * `username` - Username provided by Veryfi.
/// * `api_key` - Api key provided by Veryfi.
///
/// * `return` - A veryfi::client::Client object to call Veryfi API.
///
/// # Example
///
/// ```
/// use veryfi::client::create_client;
///
/// let client_id = "your_client_id".to_string();
/// let client_secret = "your_client_secret".to_string();
/// let username = "your_username".to_string();
/// let api_key = "your_api_key".to_string();
/// let client = create_client(client_id, client_secret, username, api_key);
/// ```
pub fn create_client(
    client_id: String,
    client_secret: String,
    username: String,
    api_key: String,
) -> Client {
    let api_version = "v8".to_string();
    return create_client_with_custom_api_version(
        client_id,
        client_secret,
        username,
        api_key,
        api_version,
    );
}

/// Create a client with custom api key.
/// # Arguments
///
/// * `client_id` - Client id provided by Veryfi.
/// * `client_secret` - Client secret provided by Veryfi.
/// * `username` - Username provided by Veryfi.
/// * `api_key` - Api key provided by Veryfi.
/// * `api_version` - Api version to use Veryfi.
///
/// * `return` - A veryfi::client::Client object to call Veryfi API.
pub fn create_client_with_custom_api_version(
    client_id: String,
    client_secret: String,
    username: String,
    api_key: String,
    api_version: String,
) -> Client {
    let url = "https://api.veryfi.com/api/".to_string();
    let api_timeout = Duration::from_secs(120);
    let client = Client {
        client_id,
        client_secret,
        username,
        api_key,
        url,
        api_version,
        api_timeout,
    };
    return client;
}