@babelforce/manager-sdk 0.5.0 → 0.38.0

package/CHANGELOG.md

@@ -3,8 +3,234 @@
 All notable changes to `@babelforce/manager-sdk` are documented here. This project adheres to
 [Semantic Versioning](https://semver.org/).
 
+## 0.38.0
+
+- **BREAKING:** Removed the `apiKey` auth mode (the `X-Auth-Access-Id` / `X-Auth-Access-Token`
+  header pair). The babelforce API no longer accepts those headers.
+- Added a `clientCredentials` OAuth2 auth mode (`grant_type=client_credentials` against
+  `/oauth/token`, fetched lazily and refreshed transparently) as the server-to-server replacement.
+
+## 0.37.0
+
+- Complete manager API parity (356/356 operations; 397/397 across all specs). Final operations:
+  `users.me`/`users.getByEmail`, `prompts.uses`, `metrics.definitions`, `babeldesk.widgetSettings`,
+  and `applications.allLocalAutomations`. Re-enabled the `full` coverage gate. (`getMe` is
+  deprecated upstream but wrapped for completeness.)
+
+## 0.36.0
+
+- Add a new `system` resource for system/reference endpoints: `echo`, `ping`, `apiStatus`,
+  `serverTime`, `timezones`, `pushToken`, `tags`, `tagsByCategory`, `exportTemplates` — 9 new
+  operations.
+
+## 0.35.0
+
+- Extend `integrations` with the action catalog and execution: `listActions`, `listActionParams`,
+  `executeAction`, and `dispatchActionGet` — 4 new operations.
+
+## 0.34.0
+
+- Extend `queues` (`bulkUpdate`, `globalSelections`, `selections.setPriority`), `outbound`
+  (`getLead`, `listLeads`), `phonebook` (`bulkDelete`), and `numbers` (`update`) — 7 new
+  operations.
+
+## 0.33.0
+
+- Extend `calls` (`cancel`, `listQueued`, `queueCallback`, and `reporting.inboundSimpleAll`) and
+  `logs` (`enableLive`, `disableLive`, `write`) — 7 new operations.
+
+## 0.32.0
+
+- Extend `settings` with generic scope/key operations (`listAll`, `listInScope`, `clear`,
+  `clearInScope`, `clearAll`) and `applications` (`clone`, `bulkUpdate`, `listActions`,
+  `listErrors`) — 9 new operations.
+
+## 0.31.0
+
+- Extend `conversations` (`addEvent`, `open`, `close`, `firstEvent`, `latestEvent`, `allEvents`)
+  and `sms` (`send`, `delete`, `report`, `testInbound`) — 10 new operations.
+
+## 0.30.0
+
+- Extend `businesshours` (range `addRanges`/`listRanges`/`getRange`/`removeRange`,
+  `bulkUpdate`/`bulkDelete`) and `calendars` (individual-date `getDate`/`updateDate`/`removeDate`,
+  `testDate`, `bulkUpdate`/`bulkDelete`) — 12 new operations.
+
+## 0.29.0
+
+- Extend `agents` with bulk actions (`bulkAction`), CSV `export`/`import`/`validateImport` +
+  `getImportJob`, per-agent and global activity `logs`/`allLogs`, `push`, `updatePassword`, and
+  group membership (`groups.removeAgent`, `groups.listAgents`, `groups.bulkDelete`) — 12 new
+  operations.
+
+## 0.28.0
+
+- Extend `agents` with named presence CRUD (`presences`, `getPresence`, `createPresence`,
+  `updatePresence`, `deletePresence`), status reads (`getStatus`, `availableStatuses`), and
+  lifecycle controls (`enable`, `disable`, `hangupCall`) — 10 new operations.
+
+## 0.27.0
+
+- Extend `triggers` (expression/operator catalogs, `conditions`/`setConditions`, `uses`,
+  `bulkAction`), `automations` (`clone`, `dispatch`, `bulkUpdate`/`bulkDelete` of event triggers),
+  and `queues` (`listTriggers`) — 11 new operations.
+
+## 0.26.0
+
+- Extend `outbound` with outbound-list management (`getList`/`updateList`/`deleteList`),
+  lead/attempt browsing (`leads`/`processedLeads`/`attempts` + simple reporting),
+  `createAgentCall`, bulk lead deletion, and CSV lead uploads (11 new operations).
+
+## 0.25.0
+
+- Extend `campaigns` with realtime `status`/`statistics`, `hopper`, `leads`/`processedLeads`,
+  `attempts`, lead-list assignment (`getList`/`setList`/`setListById`/`unsetList`), and
+  `logoutAllAgents` (11 new operations).
+
+## 0.24.0
+
+- Extend `integrations` with the provider catalog, OAuth token management (`listTokens`,
+  `getToken`, `refreshToken`, `deleteToken`), `clone`, `authorize`, `integrate`, type actions
+  (`typeActions`, `dispatchTypeAction`), the API proxy (`apiProxyGet`/`apiProxyPost`), templates,
+  and bulk update/delete (16 new operations).
+
+## 0.23.0
+
+- Add the `recordings` resource (v2 manager API): `list`/`listAll`, `start`, `get`, `update`,
+  `delete`, `bulkAction`, plus recording flags (`getFlag`, `flag`, `unflag`, `toggleFlag`).
+
+## 0.22.0
+
+- Add the `dialer` resource (v2 manager API): `info`, `flush`, `simpleReporting` /
+  `simpleReportingAll` (auto-paginated dialer call report), plus a nested `dialer.behaviours`
+  sub-resource (CRUD).
+
+## 0.21.0
+
+- Add the `files` resource (v2 manager API): `list`/`listAll` (auto-paginated), `listByType`,
+  `backups`, `recordings`, `prompts`, `get`, `delete`, `download`, `bulkDelete`, `bulkDownload`,
+  `bulkDownloadPost`.
+
+## 0.20.0
+
+- Add the `dashboards` resource (v2 manager API): `list` / `listAll` (auto-paginated), `create`,
+  `get`, `update`, `delete`, plus dashboard-user access (`listUsers`, `addUser`, `removeUser`).
+
+## 0.19.0
+
+- Add the `auth` resource — the **OAuth 2.0** endpoints (`/oauth/authorize`, `/oauth/token`,
+  `/oauth/revoke`): `mgr.auth.token`, `mgr.auth.revoke`, `mgr.auth.authorize`. These authenticate
+  via client credentials in the request, independent of the SDK's api-key/bearer auth.
+
+## 0.18.0
+
+- **Refreshed the manager OpenAPI spec** (a large upstream expansion: 187 → 356 operations) and
+  **vendored the new `auth` (OAuth 2.0) spec**. The low-level generated clients now cover the new
+  surface; ergonomic facade methods for the new operations land in follow-up releases.
+- **Breaking — removed operations no longer in the spec:** `conversations.getEvent`,
+  `calls.reporting.simpleByType` / `simpleAllByType`, `metrics.push`, `metrics.reset`.
+- **Breaking — changed signatures:** `calendars.addDate(id, body)` now takes a `CalendarDateBody`
+  and returns `CalendarDateItemResponse`; `calendars.getDates` returns `CalendarDateListResponse`.
+- Coverage is tracked against the new 397-operation scope; the SDK currently wraps ~56% while the
+  newly-added operations are wrapped over the coming releases.
+
+## 0.17.0
+
+- Extend `tasks` with `tasks.metrics` (task journal, agent journal, agent interaction durations),
+  `usage` / `usageTypes`, `logs` (customer logs), `agentAction`, `setAgentLock`, `changeState`, and
+  `testAction`.
+- **The SDK now wraps 100% of every babelforce manager spec** (manager v2, user, task-automation,
+  task-schedule); the only excluded operation is the Zendesk webhook receiver, which is not a client call.
+
+## 0.16.0
+
+- Extend `tasks` (v3 task automation) with `tasks.scripts` (script CRUD by type), `tasks.secrets`
+  (prefixes, keys, create/patch/delete), and `tasks.selectionConfig` (account task-selection
+  configuration: read/create/update/delete).
+
+## 0.15.0
+
+- Add the `events` resource (`list`, `createCustom`, `deleteCustom`), the `logs` resource (`audit` /
+  `auditAll` auto-paginated, `live`), and the `expressions` resource (`list`, `evaluate`).
+- Extend `integrations` with `dispatchAction` and `actionVariables`.
+- **The TypeScript SDK now wraps 100% of the manager (v2) API.**
+
+## 0.14.0
+
+- Add the `prompts` resource (v2 audio prompts): `list` / `listAll`, `get`, `upload`, `update`,
+  `delete`.
+- Add the `babeldesk` resource (v2 babeldesk dashboards): `list` / `listAll`, `create`, `get`,
+  `update`, `delete`, plus a nested `babeldesk.widgets` sub-resource (widget CRUD).
+
+## 0.13.0
+
+- Add the `conversations` resource (v2 conversations): `list` / `listAll`, `create`, `get`,
+  `update`, `delete`, plus `events`, `getEvent`, `getSession`, `updateSession`.
+- Add the `sessions` resource (v2 sessions): `create`, `get`, `updateVariables`.
+
+## 0.12.0
+
+- Add the `businessHours` resource (v2 business hours): `list` / `listAll`, `create`, `get`,
+  `update`, `delete`.
+- Add the `calendars` resource (v2 calendars): `list` / `listAll`, `create`, `get`, `update`,
+  `delete`, plus `getDates` / `addDate`.
+
+## 0.11.0
+
+- Add the `outbound` resource (v2 dialer lists & leads): `lists`, `createList`, `clearList`,
+  `addLead`, `updateLead`, `deleteLead`.
+- Add the `phonebook` resource (v2 phonebook): `list` / `listAll`, `create`, `get`, `update`,
+  `delete`, plus bulk `download` / `upload`.
+- Add the `campaigns` resource (v2 outbound campaigns): `list`, `create`, `get`, `update`, `delete`.
+
+## 0.10.0
+
+- Add the `integrations` resource (v2 integrations): `list` / `listAll`, `create`, `get`, `update`,
+  `delete`, `available`, `addAssociation` / `removeAssociation`, `providerLogo`, and
+  `providerSessionVariables`.
+
+## 0.9.0
+
+- Add the `routing` resource (v2 routing rules): `list` / `listAll`, `create`, `get`, `update`,
+  `delete`.
+- Add the `triggers` resource (v2 workflow triggers): CRUD plus `clone(id)` and `test(body, testMode)`.
+- Add the `automations` resource (v2 global automations / event triggers): `list` / `listAll`,
+  `create`, `get`, `update`, `delete`.
+
+## 0.8.0
+
+- Add the `queues` resource (v2 queues): `list` / `listAll`, `create`, `get`, `update`, `delete`,
+  plus a nested `queues.selections` sub-resource — selection CRUD, agent/group/tag membership
+  (`addAgent` / `removeAgent` / `addGroup` / `removeGroup` / `addTag` / `removeTag`), and
+  `selectAgents` to resolve a queue's selected agents.
+
+## 0.7.0
+
+- Extend the `calls` resource with call control: `get(id)`, `hangup(id)`, `createTestCall(body)`, and
+  `setSessionVariables(id, vars)`.
+- Add the `sms` resource (v2 SMS records): `list` / `listAll` (auto-paginated) and `get(id)`.
+- Add the `numbers` resource (v2 service numbers): `list` / `listAll`, `get(id)`, and
+  `addTags(id, tags)`.
+- Add the `conferences` resource (v2 conferences): `list` / `listAll` and `get(id)`.
+
+## 0.6.0
+
+- Extend the `users` resource: `listRoles()` (assignable role names), `addRoles(emails, roles)` /
+  `removeRoles(emails, roles)`, and `resetPasswords(emails)`.
+- Add the `me` resource (the authenticated principal, v2 user API): `get()` (current user),
+  `customer()` (current user + account info), `accounts()` (accounts the principal can access), and
+  `resetPassword()`.
+
 ## 0.5.0
 
+- **Breaking:** removed the `environment` option (and the `Environment` type export). The client now
+  targets `https://services.babelforce.com` by default — set `baseUrl` to point at another host.
+  The default is exported as `DEFAULT_BASE_URL`.
+- Add automatic retries, on by default and configurable via the new `retry` option (`false` to
+  disable, or a `RetryOptions` object to tune). Transient failures — network errors and `429`/`502`/
+  `503`/`504` — are retried with exponential backoff and jitter, honouring `Retry-After`;
+  non-idempotent requests (POST/PATCH) are only retried on `429`. Exposes `RetryOptions` and the
+  `withRetry` helper.
 - `applications.list` / `applications.actions.list`: an explicit `pageSize: 0` now means "use the
   server default" (the `max` query parameter is omitted), matching the Go SDK. It was previously sent
   as `max=0`.

package/README.md

@@ -22,8 +22,8 @@ ESM, ships with types. Node 18+ (for global `fetch`).
 import { ManagerClient } from "@babelforce/manager-sdk";
 
 const mgr = await ManagerClient.connect({
-  environment: "production",
-  auth: { kind: "apiKey", accessId, accessToken }, // or { kind: "password", user, pass }
+  auth: { kind: "clientCredentials", clientId, clientSecret }, // or { kind: "password", user, pass }
+  // baseUrl defaults to https://services.babelforce.com
 });
 
 // list users (auto-paginated)
@@ -37,7 +37,8 @@ await mgr.users.enable(["new.user@acme.com"]);
 
 ### Authentication
 
-- `{ kind: "apiKey", accessId, accessToken }` — sends `X-Auth-Access-Id` / `X-Auth-Access-Token`.
+- `{ kind: "clientCredentials", clientId, clientSecret }` — recommended for server-to-server use;
+  OAuth2 client_credentials grant against `/oauth/token` with transparent refresh.
 - `{ kind: "bearer", token }` — a token you already hold.
 - `{ kind: "password", user, pass }` — OAuth2 password grant with transparent refresh.