Skip to main content

ManagerClient

babelforce_manager_sdk

Struct ManagerClient 

Source 
pub struct ManagerClient {
Show 35 fields
    pub users: UsersResource,
    pub agents: AgentsResource,
    pub me: MeResource,
    pub calls: CallsResource,
    pub sms: SmsResource,
    pub numbers: NumbersResource,
    pub conferences: ConferencesResource,
    pub queues: QueuesResource,
    pub recordings: RecordingsResource,
    pub routing: RoutingResource,
    pub triggers: TriggersResource,
    pub automations: AutomationsResource,
    pub integrations: IntegrationsResource,
    pub outbound: OutboundResource,
    pub phonebook: PhonebookResource,
    pub campaigns: CampaignsResource,
    pub business_hours: BusinessHoursResource,
    pub calendars: CalendarsResource,
    pub conversations: ConversationsResource,
    pub dashboards: DashboardsResource,
    pub dialer: DialerResource,
    pub sessions: SessionsResource,
    pub prompts: PromptsResource,
    pub babeldesk: BabeldeskResource,
    pub events: EventsResource,
    pub expressions: ExpressionsResource,
    pub files: FilesResource,
    pub logs: LogsResource,
    pub metrics: MetricsResource,
    pub system: SystemResource,
    pub settings: SettingsResource,
    pub applications: ApplicationsResource,
    pub tasks: TasksResource,
    pub schedules: TaskSchedulesResource,
    pub auth: AuthResource,

}
Expand description

The babelforce manager SDK client. Build one with ManagerClient::connect (or ManagerClient::builder) and use its resource namespaces.

Fields§

§users: UsersResource

User management — /api/v2/users.

§agents: AgentsResource

Agent management — /api/v2/agents (with a nested groups sub-resource).

§me: MeResource

The authenticated principal — current user, accounts, password reset (/api/v2/user).

§calls: CallsResource

Call reporting & control — /api/v2/calls (with a nested reporting sub-resource).

§sms: SmsResource

SMS records — /api/v2/sms.

§numbers: NumbersResource

Service (phone) numbers — /api/v2/numbers.

§conferences: ConferencesResource

Conferences — /api/v2/conferences.

§queues: QueuesResource

Queues — /api/v2/queues (with a nested selections sub-resource).

§recordings: RecordingsResource

Call recordings — /api/v2/recordings (bulk actions and per-recording flagging).

§routing: RoutingResource

Routing rules — /api/v2/routings.

§triggers: TriggersResource

Workflow triggers — /api/v2/triggers.

§automations: AutomationsResource

Global automations (event triggers) — /api/v2/events/triggers.

§integrations: IntegrationsResource

Integrations — /api/v2/integrations.

§outbound: OutboundResource

Outbound lists & leads — /api/v2/outbound/lists.

§phonebook: PhonebookResource

Phonebook entries — /api/v2/phonebook.

§campaigns: CampaignsResource

Outbound campaigns — /api/v2/outbound/campaigns.

§business_hours: BusinessHoursResource

Business hours — /api/v2/business-hours.

§calendars: CalendarsResource

Calendars — /api/v2/calendars.

§conversations: ConversationsResource

Conversations — /api/v2/conversations (with events & session variables).

§dashboards: DashboardsResource

Reporting dashboards — /api/v2/dashboards (with per-dashboard user management).

§dialer: DialerResource

Dialer runtime & reporting — /api/v2/dialer (with a nested behaviours sub-resource).

§sessions: SessionsResource

Call/automation sessions — /api/v2/sessions.

§prompts: PromptsResource

Audio prompts — /api/v2/prompts.

§babeldesk: BabeldeskResource

Babeldesk dashboards — /api/v2/babeldesk (with a nested widgets sub-resource).

§events: EventsResource

Event definitions & custom events — /api/v2/events.

§expressions: ExpressionsResource

Expressions catalog & evaluator — /api/v2/expressions.

§files: FilesResource

Stored files — /api/v2/files (recordings, prompts, backups).

§logs: LogsResource

Audit & live logs.

§metrics: MetricsResource

Metrics — /api/v2/metrics.

§system: SystemResource

System & reference data — health checks, server time, timezones, tags, templates.

§settings: SettingsResource

Global settings — /api/v2/settings, grouped by scope.

§applications: ApplicationsResource

Applications — /api/v2/applications (with a nested local_automations sub-resource).

§tasks: TasksResource

Task automation (v3) — /api/v3/tasks (with nested scripts/secrets/selection_config/metrics).

§schedules: TaskSchedulesResource

Task schedules (v3) — /api/v3/schedules.

§auth: AuthResource

OAuth 2.0 — /oauth/authorize, /oauth/token, /oauth/revoke.

Implementations§

Source§

impl ManagerClient

Source

pub async fn connect(auth: Auth) -> Result<Self, ManagerError>

Connect with default settings (base URL DEFAULT_BASE_URL, retries on).

Source

pub fn builder(auth: Auth) -> ManagerClientBuilder

Start building a client to customise the base URL or retry policy.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more