@babelforce/manager-sdk 0.4.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +101 -0
- package/README.md +1 -1
- package/dist/index.d.ts +2669 -151
- package/dist/index.js +5184 -762
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,107 @@
|
|
|
3
3
|
All notable changes to `@babelforce/manager-sdk` are documented here. This project adheres to
|
|
4
4
|
[Semantic Versioning](https://semver.org/).
|
|
5
5
|
|
|
6
|
+
## 0.17.0
|
|
7
|
+
|
|
8
|
+
- Extend `tasks` with `tasks.metrics` (task journal, agent journal, agent interaction durations),
|
|
9
|
+
`usage` / `usageTypes`, `logs` (customer logs), `agentAction`, `setAgentLock`, `changeState`, and
|
|
10
|
+
`testAction`.
|
|
11
|
+
- **The SDK now wraps 100% of every babelforce manager spec** (manager v2, user, task-automation,
|
|
12
|
+
task-schedule); the only excluded operation is the Zendesk webhook receiver, which is not a client call.
|
|
13
|
+
|
|
14
|
+
## 0.16.0
|
|
15
|
+
|
|
16
|
+
- Extend `tasks` (v3 task automation) with `tasks.scripts` (script CRUD by type), `tasks.secrets`
|
|
17
|
+
(prefixes, keys, create/patch/delete), and `tasks.selectionConfig` (account task-selection
|
|
18
|
+
configuration: read/create/update/delete).
|
|
19
|
+
|
|
20
|
+
## 0.15.0
|
|
21
|
+
|
|
22
|
+
- Add the `events` resource (`list`, `createCustom`, `deleteCustom`), the `logs` resource (`audit` /
|
|
23
|
+
`auditAll` auto-paginated, `live`), and the `expressions` resource (`list`, `evaluate`).
|
|
24
|
+
- Extend `integrations` with `dispatchAction` and `actionVariables`.
|
|
25
|
+
- **The TypeScript SDK now wraps 100% of the manager (v2) API.**
|
|
26
|
+
|
|
27
|
+
## 0.14.0
|
|
28
|
+
|
|
29
|
+
- Add the `prompts` resource (v2 audio prompts): `list` / `listAll`, `get`, `upload`, `update`,
|
|
30
|
+
`delete`.
|
|
31
|
+
- Add the `babeldesk` resource (v2 babeldesk dashboards): `list` / `listAll`, `create`, `get`,
|
|
32
|
+
`update`, `delete`, plus a nested `babeldesk.widgets` sub-resource (widget CRUD).
|
|
33
|
+
|
|
34
|
+
## 0.13.0
|
|
35
|
+
|
|
36
|
+
- Add the `conversations` resource (v2 conversations): `list` / `listAll`, `create`, `get`,
|
|
37
|
+
`update`, `delete`, plus `events`, `getEvent`, `getSession`, `updateSession`.
|
|
38
|
+
- Add the `sessions` resource (v2 sessions): `create`, `get`, `updateVariables`.
|
|
39
|
+
|
|
40
|
+
## 0.12.0
|
|
41
|
+
|
|
42
|
+
- Add the `businessHours` resource (v2 business hours): `list` / `listAll`, `create`, `get`,
|
|
43
|
+
`update`, `delete`.
|
|
44
|
+
- Add the `calendars` resource (v2 calendars): `list` / `listAll`, `create`, `get`, `update`,
|
|
45
|
+
`delete`, plus `getDates` / `addDate`.
|
|
46
|
+
|
|
47
|
+
## 0.11.0
|
|
48
|
+
|
|
49
|
+
- Add the `outbound` resource (v2 dialer lists & leads): `lists`, `createList`, `clearList`,
|
|
50
|
+
`addLead`, `updateLead`, `deleteLead`.
|
|
51
|
+
- Add the `phonebook` resource (v2 phonebook): `list` / `listAll`, `create`, `get`, `update`,
|
|
52
|
+
`delete`, plus bulk `download` / `upload`.
|
|
53
|
+
- Add the `campaigns` resource (v2 outbound campaigns): `list`, `create`, `get`, `update`, `delete`.
|
|
54
|
+
|
|
55
|
+
## 0.10.0
|
|
56
|
+
|
|
57
|
+
- Add the `integrations` resource (v2 integrations): `list` / `listAll`, `create`, `get`, `update`,
|
|
58
|
+
`delete`, `available`, `addAssociation` / `removeAssociation`, `providerLogo`, and
|
|
59
|
+
`providerSessionVariables`.
|
|
60
|
+
|
|
61
|
+
## 0.9.0
|
|
62
|
+
|
|
63
|
+
- Add the `routing` resource (v2 routing rules): `list` / `listAll`, `create`, `get`, `update`,
|
|
64
|
+
`delete`.
|
|
65
|
+
- Add the `triggers` resource (v2 workflow triggers): CRUD plus `clone(id)` and `test(body, testMode)`.
|
|
66
|
+
- Add the `automations` resource (v2 global automations / event triggers): `list` / `listAll`,
|
|
67
|
+
`create`, `get`, `update`, `delete`.
|
|
68
|
+
|
|
69
|
+
## 0.8.0
|
|
70
|
+
|
|
71
|
+
- Add the `queues` resource (v2 queues): `list` / `listAll`, `create`, `get`, `update`, `delete`,
|
|
72
|
+
plus a nested `queues.selections` sub-resource — selection CRUD, agent/group/tag membership
|
|
73
|
+
(`addAgent` / `removeAgent` / `addGroup` / `removeGroup` / `addTag` / `removeTag`), and
|
|
74
|
+
`selectAgents` to resolve a queue's selected agents.
|
|
75
|
+
|
|
76
|
+
## 0.7.0
|
|
77
|
+
|
|
78
|
+
- Extend the `calls` resource with call control: `get(id)`, `hangup(id)`, `createTestCall(body)`, and
|
|
79
|
+
`setSessionVariables(id, vars)`.
|
|
80
|
+
- Add the `sms` resource (v2 SMS records): `list` / `listAll` (auto-paginated) and `get(id)`.
|
|
81
|
+
- Add the `numbers` resource (v2 service numbers): `list` / `listAll`, `get(id)`, and
|
|
82
|
+
`addTags(id, tags)`.
|
|
83
|
+
- Add the `conferences` resource (v2 conferences): `list` / `listAll` and `get(id)`.
|
|
84
|
+
|
|
85
|
+
## 0.6.0
|
|
86
|
+
|
|
87
|
+
- Extend the `users` resource: `listRoles()` (assignable role names), `addRoles(emails, roles)` /
|
|
88
|
+
`removeRoles(emails, roles)`, and `resetPasswords(emails)`.
|
|
89
|
+
- Add the `me` resource (the authenticated principal, v2 user API): `get()` (current user),
|
|
90
|
+
`customer()` (current user + account info), `accounts()` (accounts the principal can access), and
|
|
91
|
+
`resetPassword()`.
|
|
92
|
+
|
|
93
|
+
## 0.5.0
|
|
94
|
+
|
|
95
|
+
- **Breaking:** removed the `environment` option (and the `Environment` type export). The client now
|
|
96
|
+
targets `https://services.babelforce.com` by default — set `baseUrl` to point at another host.
|
|
97
|
+
The default is exported as `DEFAULT_BASE_URL`.
|
|
98
|
+
- Add automatic retries, on by default and configurable via the new `retry` option (`false` to
|
|
99
|
+
disable, or a `RetryOptions` object to tune). Transient failures — network errors and `429`/`502`/
|
|
100
|
+
`503`/`504` — are retried with exponential backoff and jitter, honouring `Retry-After`;
|
|
101
|
+
non-idempotent requests (POST/PATCH) are only retried on `429`. Exposes `RetryOptions` and the
|
|
102
|
+
`withRetry` helper.
|
|
103
|
+
- `applications.list` / `applications.actions.list`: an explicit `pageSize: 0` now means "use the
|
|
104
|
+
server default" (the `max` query parameter is omitted), matching the Go SDK. It was previously sent
|
|
105
|
+
as `max=0`.
|
|
106
|
+
|
|
6
107
|
## 0.4.0
|
|
7
108
|
|
|
8
109
|
- Add the `applications` resource (v2 IVR application management): `list` / `listAll`
|
package/README.md
CHANGED
|
@@ -22,8 +22,8 @@ ESM, ships with types. Node 18+ (for global `fetch`).
|
|
|
22
22
|
import { ManagerClient } from "@babelforce/manager-sdk";
|
|
23
23
|
|
|
24
24
|
const mgr = await ManagerClient.connect({
|
|
25
|
-
environment: "production",
|
|
26
25
|
auth: { kind: "apiKey", accessId, accessToken }, // or { kind: "password", user, pass }
|
|
26
|
+
// baseUrl defaults to https://services.babelforce.com
|
|
27
27
|
});
|
|
28
28
|
|
|
29
29
|
// list users (auto-paginated)
|