ghl-sdk 0.5.1

Unofficial async Rust SDK for the GoHighLevel (HighLevel) API 2.0 — OAuth 2.0, Private Integration Tokens, rate-limit-aware retries, paginated streams
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

use std::time::Duration;

use reqwest::StatusCode;

/// All errors returned by this crate.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// The API returned a non-success status code.
    #[error("GoHighLevel API error ({status}): {message}")]
    Api {
        /// HTTP status returned by the API.
        status: StatusCode,
        /// Human-readable message extracted from the error body.
        message: String,
        /// Request id echoed by the API, when present (useful in support threads).
        request_id: Option<String>,
    },

    /// The API returned 429 and retries were exhausted.
    #[error("rate limited by GoHighLevel API{}", retry_after_hint(.retry_after))]
    RateLimited {
        /// Server-suggested wait before retrying, from the `Retry-After` header.
        retry_after: Option<Duration>,
    },

    /// Authentication problems: missing credentials, failed token refresh, etc.
    #[error("authentication error: {0}")]
    Auth(String),

    /// Network / TLS / protocol-level failures.
    #[error("transport error: {0}")]
    Transport(#[from] reqwest::Error),

    /// The response body could not be decoded into the expected type.
    #[error("failed to decode response from `{endpoint}`: {source}")]
    Decode {
        /// The API path whose response failed to decode.
        endpoint: String,
        /// The underlying deserialization error.
        #[source]
        source: serde_json::Error,
    },

    /// Invalid client configuration.
    #[error("configuration error: {0}")]
    Config(String),
}

fn retry_after_hint(retry_after: &Option<Duration>) -> String {
    match retry_after {
        Some(d) => format!(" (retry after {}s)", d.as_secs()),
        None => String::new(),
    }
}

/// Crate-wide result alias.
pub type Result<T, E = Error> = std::result::Result<T, E>;