tapsilat 2026.4.2

The Tapsilat SDK for Rust
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

//! Configuration management for the Tapsilat SDK.
//!
//! This module handles SDK configuration including API keys, base URLs,
//! and request timeouts.

use crate::error::{Result, TapsilatError};

/// Configuration for the Tapsilat SDK client.
///
/// Contains all necessary configuration options for connecting to the Tapsilat API,
/// including authentication credentials and request settings.
///
/// # Example
///
/// ```rust
/// use tapsilat::Config;
///
/// let config = Config::new("your-api-key")
///     .with_base_url("https://api.tapsilat.com/v1")
///     .with_timeout(30);
/// ```
#[derive(Debug, Clone)]
pub struct Config {
    /// API key for authenticating with the Tapsilat API.
    pub api_key: String,
    /// Base URL for the Tapsilat API (default: <https://panel.tapsilat.dev/api/v1>).
    pub base_url: String,
    /// Request timeout in seconds (default: 30).
    pub timeout: u64,
}

impl Config {
    /// Creates a new configuration with the given API key.
    ///
    /// Uses default values for base URL and timeout.
    ///
    /// # Arguments
    ///
    /// * `api_key` - The API key for authenticating with Tapsilat
    ///
    /// # Example
    ///
    /// ```rust
    /// use tapsilat::Config;
    ///
    /// let config = Config::new("your-api-key");
    /// ```
    pub fn new(api_key: impl Into<String>) -> Self {
        Self {
            api_key: api_key.into(),
            base_url: "https://panel.tapsilat.dev/api/v1".to_string(),
            timeout: 30,
        }
    }

    /// Sets a custom base URL for the API.
    ///
    /// # Arguments
    ///
    /// * `base_url` - The base URL to use for API requests
    ///
    /// # Example
    ///
    /// ```rust
    /// use tapsilat::Config;
    ///
    /// let config = Config::new("api-key")
    ///     .with_base_url("https://api.staging.tapsilat.com/v1");
    /// ```
    pub fn with_base_url(mut self, base_url: impl Into<String>) -> Self {
        self.base_url = base_url.into();
        self
    }

    /// Sets a custom timeout for API requests.
    ///
    /// # Arguments
    ///
    /// * `timeout` - Timeout in seconds for API requests
    ///
    /// # Example
    ///
    /// ```rust
    /// use tapsilat::Config;
    ///
    /// let config = Config::new("api-key")
    ///     .with_timeout(60); // 60 second timeout
    /// ```
    pub fn with_timeout(mut self, timeout: u64) -> Self {
        self.timeout = timeout;
        self
    }

    /// Validates the configuration.
    ///
    /// Ensures that required fields are present and valid.
    ///
    /// # Errors
    ///
    /// Returns [`TapsilatError::ConfigError`] if:
    /// - API key is empty
    /// - Base URL is empty
    ///
    /// # Example
    ///
    /// ```rust
    /// use tapsilat::Config;
    ///
    /// let config = Config::new("api-key");
    /// config.validate().expect("Configuration should be valid");
    /// ```
    pub fn validate(&self) -> Result<()> {
        if self.api_key.is_empty() {
            return Err(TapsilatError::ConfigError(
                "API key cannot be empty".to_string(),
            ));
        }

        if self.base_url.is_empty() {
            return Err(TapsilatError::ConfigError(
                "Base URL cannot be empty".to_string(),
            ));
        }

        Ok(())
    }
}