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
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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
use crate::auth::Auth;
use crate::error::ManagerError;
use crate::gen::auth::apis::configuration::Configuration as AuthConfig;
use crate::gen::manager::apis::configuration::Configuration as ManagerConfig;
use crate::gen::task_automation::apis::configuration::Configuration as TaskAutomationConfig;
use crate::gen::task_schedule::apis::configuration::Configuration as TaskScheduleConfig;
use crate::gen::user::apis::configuration::Configuration as UserConfig;
use crate::resources::agents::{AgentGroupsResource, AgentsResource};
use crate::resources::applications::{ApplicationsResource, LocalAutomationsResource};
use crate::resources::auth::AuthResource;
use crate::resources::automations::AutomationsResource;
use crate::resources::babeldesk::{BabeldeskResource, BabeldeskWidgetsResource};
use crate::resources::businesshours::BusinessHoursResource;
use crate::resources::calendars::CalendarsResource;
use crate::resources::calls::{CallsResource, ReportingResource};
use crate::resources::campaigns::CampaignsResource;
use crate::resources::conferences::ConferencesResource;
use crate::resources::conversations::ConversationsResource;
use crate::resources::dashboards::DashboardsResource;
use crate::resources::dialer::{DialerBehavioursResource, DialerResource};
use crate::resources::events::EventsResource;
use crate::resources::expressions::ExpressionsResource;
use crate::resources::files::FilesResource;
use crate::resources::integrations::IntegrationsResource;
use crate::resources::logs::LogsResource;
use crate::resources::me::MeResource;
use crate::resources::metrics::MetricsResource;
use crate::resources::numbers::NumbersResource;
use crate::resources::outbound::OutboundResource;
use crate::resources::phonebook::PhonebookResource;
use crate::resources::prompts::PromptsResource;
use crate::resources::queues::{QueueSelectionsResource, QueuesResource};
use crate::resources::recordings::RecordingsResource;
use crate::resources::routing::RoutingResource;
use crate::resources::schedules::TaskSchedulesResource;
use crate::resources::sessions::SessionsResource;
use crate::resources::settings::SettingsResource;
use crate::resources::sms::SmsResource;
use crate::resources::system::SystemResource;
use crate::resources::tasks::{
    TaskMetricsResource, TaskScriptsResource, TaskSecretsResource, TaskSelectionConfigResource,
    TasksResource,
};
use crate::resources::triggers::TriggersResource;
use crate::resources::users::UsersResource;
use crate::retry::{RetryMiddleware, RetryPolicy};
use crate::token::{SharedCfg, TokenManager};

/// Default babelforce API host. Override with [`ManagerClientBuilder::base_url`].
pub const DEFAULT_BASE_URL: &str = "https://services.babelforce.com";

/// The babelforce manager SDK client. Build one with [`ManagerClient::connect`] (or
/// [`ManagerClient::builder`]) and use its resource namespaces.
pub struct ManagerClient {
    /// User management — `/api/v2/users`.
    pub users: UsersResource,
    /// Agent management — `/api/v2/agents` (with a nested `groups` sub-resource).
    pub agents: AgentsResource,
    /// The authenticated principal — current user, accounts, password reset (`/api/v2/user`).
    pub me: MeResource,
    /// Call reporting & control — `/api/v2/calls` (with a nested `reporting` sub-resource).
    pub calls: CallsResource,
    /// SMS records — `/api/v2/sms`.
    pub sms: SmsResource,
    /// Service (phone) numbers — `/api/v2/numbers`.
    pub numbers: NumbersResource,
    /// Conferences — `/api/v2/conferences`.
    pub conferences: ConferencesResource,
    /// Queues — `/api/v2/queues` (with a nested `selections` sub-resource).
    pub queues: QueuesResource,
    /// Call recordings — `/api/v2/recordings` (bulk actions and per-recording flagging).
    pub recordings: RecordingsResource,
    /// Routing rules — `/api/v2/routings`.
    pub routing: RoutingResource,
    /// Workflow triggers — `/api/v2/triggers`.
    pub triggers: TriggersResource,
    /// Global automations (event triggers) — `/api/v2/events/triggers`.
    pub automations: AutomationsResource,
    /// Integrations — `/api/v2/integrations`.
    pub integrations: IntegrationsResource,
    /// Outbound lists & leads — `/api/v2/outbound/lists`.
    pub outbound: OutboundResource,
    /// Phonebook entries — `/api/v2/phonebook`.
    pub phonebook: PhonebookResource,
    /// Outbound campaigns — `/api/v2/outbound/campaigns`.
    pub campaigns: CampaignsResource,
    /// Business hours — `/api/v2/business-hours`.
    pub business_hours: BusinessHoursResource,
    /// Calendars — `/api/v2/calendars`.
    pub calendars: CalendarsResource,
    /// Conversations — `/api/v2/conversations` (with events & session variables).
    pub conversations: ConversationsResource,
    /// Reporting dashboards — `/api/v2/dashboards` (with per-dashboard user management).
    pub dashboards: DashboardsResource,
    /// Dialer runtime & reporting — `/api/v2/dialer` (with a nested `behaviours` sub-resource).
    pub dialer: DialerResource,
    /// Call/automation sessions — `/api/v2/sessions`.
    pub sessions: SessionsResource,
    /// Audio prompts — `/api/v2/prompts`.
    pub prompts: PromptsResource,
    /// Babeldesk dashboards — `/api/v2/babeldesk` (with a nested `widgets` sub-resource).
    pub babeldesk: BabeldeskResource,
    /// Event definitions & custom events — `/api/v2/events`.
    pub events: EventsResource,
    /// Expressions catalog & evaluator — `/api/v2/expressions`.
    pub expressions: ExpressionsResource,
    /// Stored files — `/api/v2/files` (recordings, prompts, backups).
    pub files: FilesResource,
    /// Audit & live logs.
    pub logs: LogsResource,
    /// Metrics — `/api/v2/metrics`.
    pub metrics: MetricsResource,
    /// System & reference data — health checks, server time, timezones, tags, templates.
    pub system: SystemResource,
    /// Global settings — `/api/v2/settings`, grouped by scope.
    pub settings: SettingsResource,
    /// Applications — `/api/v2/applications` (with a nested `local_automations` sub-resource).
    pub applications: ApplicationsResource,
    /// Task automation (v3) — `/api/v3/tasks` (with nested scripts/secrets/selection_config/metrics).
    pub tasks: TasksResource,
    /// Task schedules (v3) — `/api/v3/schedules`.
    pub schedules: TaskSchedulesResource,
    /// OAuth 2.0 — `/oauth/authorize`, `/oauth/token`, `/oauth/revoke`.
    pub auth: AuthResource,
}

impl ManagerClient {
    /// Connect with default settings (base URL [`DEFAULT_BASE_URL`], retries on).
    pub async fn connect(auth: Auth) -> Result<Self, ManagerError> {
        Self::builder(auth).connect().await
    }

    /// Start building a client to customise the base URL or retry policy.
    pub fn builder(auth: Auth) -> ManagerClientBuilder {
        ManagerClientBuilder {
            base_url: DEFAULT_BASE_URL.to_string(),
            auth,
            retry: RetryPolicy::default(),
        }
    }
}

/// Builder for [`ManagerClient`].
pub struct ManagerClientBuilder {
    base_url: String,
    auth: Auth,
    retry: RetryPolicy,
}

impl ManagerClientBuilder {
    /// Override the base URL (e.g. a per-customer host). Defaults to [`DEFAULT_BASE_URL`].
    pub fn base_url(mut self, url: impl Into<String>) -> Self {
        self.base_url = url.into();
        self
    }

    /// Override the retry policy. Defaults to [`RetryPolicy::default`].
    pub fn retry(mut self, policy: RetryPolicy) -> Self {
        self.retry = policy;
        self
    }

    /// Build the client, resolving a grant into a bearer token if needed (kept fresh from then
    /// on — see [`Auth`]).
    pub async fn connect(self) -> Result<ManagerClient, ManagerError> {
        let base = self.base_url.trim_end_matches('/').to_string();

        // Static headers only ([`Auth::Bearer`]). Grant-resolved tokens travel per-request via
        // the configurations' `oauth_access_token`, so a mid-life re-grant never needs to
        // rebuild this client.
        let http = reqwest::Client::builder()
            .default_headers(self.auth.static_headers())
            .build()
            .map_err(|e| ManagerError::Network(e.to_string()))?;
        // Retries live in transport middleware (see `crate::retry`), so every request — generated
        // clients, raw JSON paths and `/oauth/token` grants — shares one retry behaviour,
        // matching the TS fetch wrapper / Go RoundTripper.
        let http = reqwest_middleware::ClientBuilder::new(http)
            .with(RetryMiddleware::new(self.retry.clone()))
            .build();

        // Resolve grant-based auth eagerly (fail fast at connect); the manager then re-grants
        // transparently whenever a call would use the token within 30s of expiry.
        let token_manager = TokenManager::connect(&base, &self.auth, http.clone()).await?;
        let (epoch, token) = match &token_manager {
            Some(manager) => {
                let (epoch, token) = manager.current().await?;
                (epoch, Some(token))
            }
            None => (0, None),
        };

        let user_agent =
            Some(concat!("babelforce-manager-sdk-rust/", env!("CARGO_PKG_VERSION")).to_string());

        let cfg = SharedCfg::new(
            ManagerConfig {
                base_path: base.clone(),
                user_agent: user_agent.clone(),
                client: http.clone(),
                basic_auth: None,
                oauth_access_token: token.clone(),
                bearer_access_token: None,
                api_key: None,
            },
            token_manager.clone(),
            epoch,
        );

        // The other specs live on the same host and share the reqwest client + token lifecycle.
        let user_cfg = SharedCfg::new(
            UserConfig {
                base_path: base.clone(),
                user_agent: user_agent.clone(),
                client: http.clone(),
                basic_auth: None,
                oauth_access_token: token.clone(),
                bearer_access_token: None,
                api_key: None,
            },
            token_manager.clone(),
            epoch,
        );
        let task_automation_cfg = SharedCfg::new(
            TaskAutomationConfig {
                base_path: base.clone(),
                user_agent: user_agent.clone(),
                client: http.clone(),
                basic_auth: None,
                oauth_access_token: token.clone(),
                bearer_access_token: None,
                api_key: None,
            },
            token_manager.clone(),
            epoch,
        );
        let task_schedule_cfg = SharedCfg::new(
            TaskScheduleConfig {
                base_path: base.clone(),
                user_agent: user_agent.clone(),
                client: http.clone(),
                basic_auth: None,
                oauth_access_token: token.clone(),
                bearer_access_token: None,
                api_key: None,
            },
            token_manager.clone(),
            epoch,
        );
        // OAuth endpoints carry their credentials in the request body, but share the same
        // host/client.
        let auth_cfg = SharedCfg::new(
            AuthConfig {
                base_path: base,
                user_agent,
                client: http,
                basic_auth: None,
                oauth_access_token: token,
                bearer_access_token: None,
                api_key: None,
            },
            token_manager,
            epoch,
        );

        Ok(ManagerClient {
            users: UsersResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            agents: AgentsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
                groups: AgentGroupsResource {
                    cfg: cfg.clone(),
                    retry: self.retry.clone(),
                },
            },
            me: MeResource {
                cfg: user_cfg,
                retry: self.retry.clone(),
            },
            calls: CallsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
                reporting: ReportingResource {
                    cfg: cfg.clone(),
                    retry: self.retry.clone(),
                },
            },
            sms: SmsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            numbers: NumbersResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            conferences: ConferencesResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            queues: QueuesResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
                selections: QueueSelectionsResource {
                    cfg: cfg.clone(),
                    retry: self.retry.clone(),
                },
            },
            recordings: RecordingsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            routing: RoutingResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            triggers: TriggersResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            automations: AutomationsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            integrations: IntegrationsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            outbound: OutboundResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            phonebook: PhonebookResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            campaigns: CampaignsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            business_hours: BusinessHoursResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            calendars: CalendarsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            conversations: ConversationsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            dashboards: DashboardsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            dialer: DialerResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
                behaviours: DialerBehavioursResource {
                    cfg: cfg.clone(),
                    retry: self.retry.clone(),
                },
            },
            sessions: SessionsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            prompts: PromptsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            babeldesk: BabeldeskResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
                widgets: BabeldeskWidgetsResource {
                    cfg: cfg.clone(),
                    retry: self.retry.clone(),
                },
            },
            events: EventsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            expressions: ExpressionsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            files: FilesResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            logs: LogsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            metrics: MetricsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            system: SystemResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            settings: SettingsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
            },
            applications: ApplicationsResource {
                cfg: cfg.clone(),
                retry: self.retry.clone(),
                local_automations: LocalAutomationsResource {
                    cfg: cfg.clone(),
                    retry: self.retry.clone(),
                },
            },
            tasks: TasksResource {
                cfg: task_automation_cfg.clone(),
                retry: self.retry.clone(),
                scripts: TaskScriptsResource {
                    cfg: task_automation_cfg.clone(),
                    retry: self.retry.clone(),
                },
                secrets: TaskSecretsResource {
                    cfg: task_automation_cfg.clone(),
                    retry: self.retry.clone(),
                },
                selection_config: TaskSelectionConfigResource {
                    cfg: task_automation_cfg.clone(),
                    retry: self.retry.clone(),
                },
                metrics: TaskMetricsResource {
                    cfg: task_automation_cfg.clone(),
                    retry: self.retry.clone(),
                },
            },
            schedules: TaskSchedulesResource {
                cfg: task_schedule_cfg,
                retry: self.retry.clone(),
            },
            auth: AuthResource {
                cfg: auth_cfg,
                retry: self.retry.clone(),
            },
        })
    }
}