babelforce-manager-sdk 0.46.0

Rust SDK for the babelforce manager APIs — auth, user & agent management, call reporting, metrics, and task automations.
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

use crate::error::{map_manager_err, ManagerError};
use crate::gen::manager::apis::configuration::Configuration;
use crate::gen::manager::apis::manager_api as api;
use crate::gen::manager::models;
use crate::retry::{with_retry, RetryPolicy};
use crate::token::SharedCfg;

/// System & reference data — health checks, server time, timezones, tags, templates.
pub struct SystemResource {
    pub(crate) cfg: SharedCfg<Configuration>,
    pub(crate) retry: RetryPolicy,
}

impl SystemResource {
    /// Echo back the request — `/api/v2/echo`.
    pub async fn echo(&self) -> Result<models::GenericItemResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::echo(cfg))
            .await
            .map_err(map_manager_err)
    }

    /// Liveness ping — `/api/v2/ping`.
    pub async fn ping(&self) -> Result<models::GenericItemResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::ping(cfg))
            .await
            .map_err(map_manager_err)
    }

    /// API status — `/api/v2/status`.
    pub async fn api_status(&self) -> Result<models::GenericItemResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::get_api_status(cfg))
            .await
            .map_err(map_manager_err)
    }

    /// Current server time — `/api/v2/data/time`.
    pub async fn server_time(&self) -> Result<models::GenericItemResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::get_server_time(cfg))
            .await
            .map_err(map_manager_err)
    }

    /// List timezones, optionally filtered by `q` and capped by `max` — `/api/v2/data/timezones`.
    pub async fn timezones(
        &self,
        q: Option<&str>,
        max: Option<i32>,
    ) -> Result<models::ObjectListResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::list_timezones(cfg, q, max))
            .await
            .map_err(map_manager_err)
    }

    /// Fetch the push notification token — `/api/v2/push-token`.
    pub async fn push_token(&self) -> Result<models::GenericItemResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::get_push_token(cfg))
            .await
            .map_err(map_manager_err)
    }

    /// List all tags — `/api/v2/tags`.
    pub async fn tags(&self) -> Result<models::ObjectListResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::list_tags(cfg))
            .await
            .map_err(map_manager_err)
    }

    /// List tags in a category — `/api/v2/tags/{category}`.
    pub async fn tags_by_category(
        &self,
        category: &str,
    ) -> Result<models::ObjectListResponse, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || {
            api::list_tags_by_category(cfg, category)
        })
        .await
        .map_err(map_manager_err)
    }

    /// Export templates of a given type — `/api/v2/templates/export/{type}`.
    pub async fn export_templates(
        &self,
        r#type: &str,
    ) -> Result<std::collections::HashMap<String, serde_json::Value>, ManagerError> {
        let cfg = self.cfg.get().await?;
        let cfg = cfg.as_ref();
        with_retry(&self.retry, true, || api::export_templates(cfg, r#type))
            .await
            .map_err(map_manager_err)
    }
}