@babelforce/manager-sdk 0.17.0 → 0.39.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 +140 -0
- package/README.md +3 -2
- package/dist/index.d.ts +3367 -299
- package/dist/index.js +4311 -2387
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,146 @@
|
|
|
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.39.0
|
|
7
|
+
|
|
8
|
+
- Refreshed the vendored manager API spec (richer endpoint descriptions/examples) and regenerated
|
|
9
|
+
the client. No operations added or removed — coverage stays at 397/397.
|
|
10
|
+
- Schema corrections carried over from the refresh: the routing `number` field is now typed as a
|
|
11
|
+
phone-number reference (it previously aliased the application schema), agent-outbound telephony
|
|
12
|
+
settings have their own request-data type, and session-variable bodies are typed as string→value
|
|
13
|
+
maps.
|
|
14
|
+
|
|
15
|
+
## 0.38.0
|
|
16
|
+
|
|
17
|
+
- **BREAKING:** Removed the `apiKey` auth mode (the `X-Auth-Access-Id` / `X-Auth-Access-Token`
|
|
18
|
+
header pair). The babelforce API no longer accepts those headers.
|
|
19
|
+
- Added a `clientCredentials` OAuth2 auth mode (`grant_type=client_credentials` against
|
|
20
|
+
`/oauth/token`, fetched lazily and refreshed transparently) as the server-to-server replacement.
|
|
21
|
+
|
|
22
|
+
## 0.37.0
|
|
23
|
+
|
|
24
|
+
- Complete manager API parity (356/356 operations; 397/397 across all specs). Final operations:
|
|
25
|
+
`users.me`/`users.getByEmail`, `prompts.uses`, `metrics.definitions`, `babeldesk.widgetSettings`,
|
|
26
|
+
and `applications.allLocalAutomations`. Re-enabled the `full` coverage gate. (`getMe` is
|
|
27
|
+
deprecated upstream but wrapped for completeness.)
|
|
28
|
+
|
|
29
|
+
## 0.36.0
|
|
30
|
+
|
|
31
|
+
- Add a new `system` resource for system/reference endpoints: `echo`, `ping`, `apiStatus`,
|
|
32
|
+
`serverTime`, `timezones`, `pushToken`, `tags`, `tagsByCategory`, `exportTemplates` — 9 new
|
|
33
|
+
operations.
|
|
34
|
+
|
|
35
|
+
## 0.35.0
|
|
36
|
+
|
|
37
|
+
- Extend `integrations` with the action catalog and execution: `listActions`, `listActionParams`,
|
|
38
|
+
`executeAction`, and `dispatchActionGet` — 4 new operations.
|
|
39
|
+
|
|
40
|
+
## 0.34.0
|
|
41
|
+
|
|
42
|
+
- Extend `queues` (`bulkUpdate`, `globalSelections`, `selections.setPriority`), `outbound`
|
|
43
|
+
(`getLead`, `listLeads`), `phonebook` (`bulkDelete`), and `numbers` (`update`) — 7 new
|
|
44
|
+
operations.
|
|
45
|
+
|
|
46
|
+
## 0.33.0
|
|
47
|
+
|
|
48
|
+
- Extend `calls` (`cancel`, `listQueued`, `queueCallback`, and `reporting.inboundSimpleAll`) and
|
|
49
|
+
`logs` (`enableLive`, `disableLive`, `write`) — 7 new operations.
|
|
50
|
+
|
|
51
|
+
## 0.32.0
|
|
52
|
+
|
|
53
|
+
- Extend `settings` with generic scope/key operations (`listAll`, `listInScope`, `clear`,
|
|
54
|
+
`clearInScope`, `clearAll`) and `applications` (`clone`, `bulkUpdate`, `listActions`,
|
|
55
|
+
`listErrors`) — 9 new operations.
|
|
56
|
+
|
|
57
|
+
## 0.31.0
|
|
58
|
+
|
|
59
|
+
- Extend `conversations` (`addEvent`, `open`, `close`, `firstEvent`, `latestEvent`, `allEvents`)
|
|
60
|
+
and `sms` (`send`, `delete`, `report`, `testInbound`) — 10 new operations.
|
|
61
|
+
|
|
62
|
+
## 0.30.0
|
|
63
|
+
|
|
64
|
+
- Extend `businesshours` (range `addRanges`/`listRanges`/`getRange`/`removeRange`,
|
|
65
|
+
`bulkUpdate`/`bulkDelete`) and `calendars` (individual-date `getDate`/`updateDate`/`removeDate`,
|
|
66
|
+
`testDate`, `bulkUpdate`/`bulkDelete`) — 12 new operations.
|
|
67
|
+
|
|
68
|
+
## 0.29.0
|
|
69
|
+
|
|
70
|
+
- Extend `agents` with bulk actions (`bulkAction`), CSV `export`/`import`/`validateImport` +
|
|
71
|
+
`getImportJob`, per-agent and global activity `logs`/`allLogs`, `push`, `updatePassword`, and
|
|
72
|
+
group membership (`groups.removeAgent`, `groups.listAgents`, `groups.bulkDelete`) — 12 new
|
|
73
|
+
operations.
|
|
74
|
+
|
|
75
|
+
## 0.28.0
|
|
76
|
+
|
|
77
|
+
- Extend `agents` with named presence CRUD (`presences`, `getPresence`, `createPresence`,
|
|
78
|
+
`updatePresence`, `deletePresence`), status reads (`getStatus`, `availableStatuses`), and
|
|
79
|
+
lifecycle controls (`enable`, `disable`, `hangupCall`) — 10 new operations.
|
|
80
|
+
|
|
81
|
+
## 0.27.0
|
|
82
|
+
|
|
83
|
+
- Extend `triggers` (expression/operator catalogs, `conditions`/`setConditions`, `uses`,
|
|
84
|
+
`bulkAction`), `automations` (`clone`, `dispatch`, `bulkUpdate`/`bulkDelete` of event triggers),
|
|
85
|
+
and `queues` (`listTriggers`) — 11 new operations.
|
|
86
|
+
|
|
87
|
+
## 0.26.0
|
|
88
|
+
|
|
89
|
+
- Extend `outbound` with outbound-list management (`getList`/`updateList`/`deleteList`),
|
|
90
|
+
lead/attempt browsing (`leads`/`processedLeads`/`attempts` + simple reporting),
|
|
91
|
+
`createAgentCall`, bulk lead deletion, and CSV lead uploads (11 new operations).
|
|
92
|
+
|
|
93
|
+
## 0.25.0
|
|
94
|
+
|
|
95
|
+
- Extend `campaigns` with realtime `status`/`statistics`, `hopper`, `leads`/`processedLeads`,
|
|
96
|
+
`attempts`, lead-list assignment (`getList`/`setList`/`setListById`/`unsetList`), and
|
|
97
|
+
`logoutAllAgents` (11 new operations).
|
|
98
|
+
|
|
99
|
+
## 0.24.0
|
|
100
|
+
|
|
101
|
+
- Extend `integrations` with the provider catalog, OAuth token management (`listTokens`,
|
|
102
|
+
`getToken`, `refreshToken`, `deleteToken`), `clone`, `authorize`, `integrate`, type actions
|
|
103
|
+
(`typeActions`, `dispatchTypeAction`), the API proxy (`apiProxyGet`/`apiProxyPost`), templates,
|
|
104
|
+
and bulk update/delete (16 new operations).
|
|
105
|
+
|
|
106
|
+
## 0.23.0
|
|
107
|
+
|
|
108
|
+
- Add the `recordings` resource (v2 manager API): `list`/`listAll`, `start`, `get`, `update`,
|
|
109
|
+
`delete`, `bulkAction`, plus recording flags (`getFlag`, `flag`, `unflag`, `toggleFlag`).
|
|
110
|
+
|
|
111
|
+
## 0.22.0
|
|
112
|
+
|
|
113
|
+
- Add the `dialer` resource (v2 manager API): `info`, `flush`, `simpleReporting` /
|
|
114
|
+
`simpleReportingAll` (auto-paginated dialer call report), plus a nested `dialer.behaviours`
|
|
115
|
+
sub-resource (CRUD).
|
|
116
|
+
|
|
117
|
+
## 0.21.0
|
|
118
|
+
|
|
119
|
+
- Add the `files` resource (v2 manager API): `list`/`listAll` (auto-paginated), `listByType`,
|
|
120
|
+
`backups`, `recordings`, `prompts`, `get`, `delete`, `download`, `bulkDelete`, `bulkDownload`,
|
|
121
|
+
`bulkDownloadPost`.
|
|
122
|
+
|
|
123
|
+
## 0.20.0
|
|
124
|
+
|
|
125
|
+
- Add the `dashboards` resource (v2 manager API): `list` / `listAll` (auto-paginated), `create`,
|
|
126
|
+
`get`, `update`, `delete`, plus dashboard-user access (`listUsers`, `addUser`, `removeUser`).
|
|
127
|
+
|
|
128
|
+
## 0.19.0
|
|
129
|
+
|
|
130
|
+
- Add the `auth` resource — the **OAuth 2.0** endpoints (`/oauth/authorize`, `/oauth/token`,
|
|
131
|
+
`/oauth/revoke`): `mgr.auth.token`, `mgr.auth.revoke`, `mgr.auth.authorize`. These authenticate
|
|
132
|
+
via client credentials in the request, independent of the SDK's api-key/bearer auth.
|
|
133
|
+
|
|
134
|
+
## 0.18.0
|
|
135
|
+
|
|
136
|
+
- **Refreshed the manager OpenAPI spec** (a large upstream expansion: 187 → 356 operations) and
|
|
137
|
+
**vendored the new `auth` (OAuth 2.0) spec**. The low-level generated clients now cover the new
|
|
138
|
+
surface; ergonomic facade methods for the new operations land in follow-up releases.
|
|
139
|
+
- **Breaking — removed operations no longer in the spec:** `conversations.getEvent`,
|
|
140
|
+
`calls.reporting.simpleByType` / `simpleAllByType`, `metrics.push`, `metrics.reset`.
|
|
141
|
+
- **Breaking — changed signatures:** `calendars.addDate(id, body)` now takes a `CalendarDateBody`
|
|
142
|
+
and returns `CalendarDateItemResponse`; `calendars.getDates` returns `CalendarDateListResponse`.
|
|
143
|
+
- Coverage is tracked against the new 397-operation scope; the SDK currently wraps ~56% while the
|
|
144
|
+
newly-added operations are wrapped over the coming releases.
|
|
145
|
+
|
|
6
146
|
## 0.17.0
|
|
7
147
|
|
|
8
148
|
- Extend `tasks` with `tasks.metrics` (task journal, agent journal, agent interaction durations),
|
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ 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
|
-
auth: { kind: "
|
|
25
|
+
auth: { kind: "clientCredentials", clientId, clientSecret }, // or { kind: "password", user, pass }
|
|
26
26
|
// baseUrl defaults to https://services.babelforce.com
|
|
27
27
|
});
|
|
28
28
|
|
|
@@ -37,7 +37,8 @@ await mgr.users.enable(["new.user@acme.com"]);
|
|
|
37
37
|
|
|
38
38
|
### Authentication
|
|
39
39
|
|
|
40
|
-
- `{ kind: "
|
|
40
|
+
- `{ kind: "clientCredentials", clientId, clientSecret }` — recommended for server-to-server use;
|
|
41
|
+
OAuth2 client_credentials grant against `/oauth/token` with transparent refresh.
|
|
41
42
|
- `{ kind: "bearer", token }` — a token you already hold.
|
|
42
43
|
- `{ kind: "password", user, pass }` — OAuth2 password grant with transparent refresh.
|
|
43
44
|
|