@epilot/sdk 2.20.79 → 2.20.80

package/docs/phone-integration.md

@@ -27,7 +27,22 @@ const { data } = await phoneIntegrationClient.batchSearchCustomers(...)
 **phone-integration**
 - [`batchSearchCustomers`](#batchsearchcustomers)
 
+**manager**
+- [`getManagerStatus`](#getmanagerstatus)
+- [`listPhoneAgents`](#listphoneagents)
+- [`assignPhoneAgent`](#assignphoneagent)
+- [`removePhoneAgent`](#removephoneagent)
+
+**operator**
+- [`getProviderSetup`](#getprovidersetup)
+- [`setupProvider`](#setupprovider)
+
 **Schemas**
+- [`ManagerStatus`](#managerstatus)
+- [`PhoneAgent`](#phoneagent)
+- [`AssignPhoneAgentRequest`](#assignphoneagentrequest)
+- [`ProviderSetup`](#providersetup)
+- [`ProviderSetupRequest`](#providersetuprequest)
 - [`CustomerBatchSearchResult`](#customerbatchsearchresult)
 - [`CustomerSearchResult`](#customersearchresult)
 - [`CustomerIdentifier`](#customeridentifier)
@@ -78,8 +93,286 @@ const { data } = await client.batchSearchCustomers({
 
 ---
 
+### `getManagerStatus`
+
+Whether the caller's organization is ready for phone agents: the telephony provider tenant
+exists and is configured. The control center shows a "not set up" state when `ready` is false.
+Requires `phon
+
+`GET /v1/manager/status`
+
+```ts
+const { data } = await client.getManagerStatus()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "provider": "babelforce",
+  "ready": true,
+  "reasons": ["provider_tenant_missing"]
+}
+```
+
+</details>
+
+---
+
+### `listPhoneAgents`
+
+Organization members who hold the phone (`phone:use`), each joined with the provider user behind
+them. Requires `phone:manage`.
+
+`GET /v1/manager/agents`
+
+```ts
+const { data } = await client.listPhoneAgents()
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "results": [
+    {
+      "user_id": "string",
+      "email": "string",
+      "display_name": "string",
+      "status": "active",
+      "provider_user_id": "string",
+      "provider_roles": ["string"],
+      "assigned_at": "1970-01-01T00:00:00.000Z",
+      "assigned_by": "string"
+    }
+  ]
+}
+```
+
+</details>
+
+---
+
+### `assignPhoneAgent`
+
+Gives an organization member the phone. In order: the member is verified with user-api, their
+pairwise subject for the provider is read from identity-api, the provider user is created (or
+found) bound
+
+`POST /v1/manager/agents`
+
+```ts
+const { data } = await client.assignPhoneAgent(
+  null,
+  {
+    user_id: 'string'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "user_id": "string",
+  "email": "string",
+  "display_name": "string",
+  "status": "active",
+  "provider_user_id": "string",
+  "provider_roles": ["string"],
+  "assigned_at": "1970-01-01T00:00:00.000Z",
+  "assigned_by": "string"
+}
+```
+
+</details>
+
+---
+
+### `removePhoneAgent`
+
+Takes the phone away from a member: the `phone_agent` role is removed first, then the provider
+user is deactivated (never deleted: call history keeps referring to it). Requires `phone:manage`.
+
+`DELETE /v1/manager/agents/{user_id}`
+
+```ts
+const { data } = await client.removePhoneAgent({
+  user_id: 'example',
+})
+```
+
+---
+
+### `getProviderSetup`
+
+What has been set up at the telephony provider for this organization.
+
+`GET /v1/operator/organizations/{org_id}/provider`
+
+```ts
+const { data } = await client.getProviderSetup({
+  org_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "provider": "babelforce",
+  "org_id": "string",
+  "ready": true,
+  "tenant": {
+    "id": "string",
+    "name": "string",
+    "org_key": "string",
+    "created_at": "1970-01-01T00:00:00.000Z"
+  },
+  "scim": {
+    "configured": true,
+    "roles_enabled": true
+  },
+  "sso": {
+    "configured": true,
+    "identity_client_id": "string",
+    "configured_at": "1970-01-01T00:00:00.000Z"
+  },
+  "last_setup_by": "string"
+}
+```
+
+</details>
+
+---
+
+### `setupProvider`
+
+Prepares the telephony provider for an organization, idempotently and in order: the provider
+tenant (Babelforce sub-account keyed by the organization id), its SCIM configuration with role
+management o
+
+`POST /v1/operator/organizations/{org_id}/provider:setup`
+
+```ts
+const { data } = await client.setupProvider(
+  {
+    org_id: 'example',
+  },
+  {
+    account_name: 'string',
+    identity_client_id: 'string',
+    identity_client_secret: 'stringstring'
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "provider": "babelforce",
+  "org_id": "string",
+  "ready": true,
+  "tenant": {
+    "id": "string",
+    "name": "string",
+    "org_key": "string",
+    "created_at": "1970-01-01T00:00:00.000Z"
+  },
+  "scim": {
+    "configured": true,
+    "roles_enabled": true
+  },
+  "sso": {
+    "configured": true,
+    "identity_client_id": "string",
+    "configured_at": "1970-01-01T00:00:00.000Z"
+  },
+  "last_setup_by": "string"
+}
+```
+
+</details>
+
+---
+
 ## Schemas
 
+### `ManagerStatus`
+
+```ts
+type ManagerStatus = {
+  provider: "babelforce"
+  ready: boolean
+  reasons: "provider_tenant_missing" | "sso_not_configured" | "scim_not_configured" | "identity_enablement_missing"[]
+}
+```
+
+### `PhoneAgent`
+
+```ts
+type PhoneAgent = {
+  user_id: string
+  email: string
+  display_name?: string
+  status: "active" | "pending" | "disabled" | "missing_provider" | "missing_role"
+  provider_user_id?: string
+  provider_roles?: string[]
+  assigned_at?: string // date-time
+  assigned_by?: string
+}
+```
+
+### `AssignPhoneAgentRequest`
+
+```ts
+type AssignPhoneAgentRequest = {
+  user_id: string
+}
+```
+
+### `ProviderSetup`
+
+```ts
+type ProviderSetup = {
+  provider: "babelforce"
+  org_id: string
+  ready: boolean
+  tenant: {
+    id: string
+    name: string
+    org_key: string
+    created_at?: string // date-time
+  }
+  scim: {
+    configured: boolean
+    roles_enabled: boolean
+  }
+  sso: {
+    configured: boolean
+    identity_client_id?: string
+    configured_at?: string // date-time
+  }
+  last_setup_by?: string
+}
+```
+
+### `ProviderSetupRequest`
+
+```ts
+type ProviderSetupRequest = {
+  account_name?: string
+  identity_client_id: string
+  identity_client_secret: string
+}
+```
+
 ### `CustomerBatchSearchResult`
 
 ```ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/sdk",
-  "version": "2.20.79",
+  "version": "2.20.80",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/chunk-UFMZ4EV3.js

@@ -1,14 +0,0 @@
-import {
-  __commonJS
-} from "./chunk-YPSWSI3M.js";
-
-// src/definitions/phone-integration-runtime.json
-var require_phone_integration_runtime = __commonJS({
-  "src/definitions/phone-integration-runtime.json"(exports, module) {
-    module.exports = { s: "https://phone-integration-api.sls.epilot.io", o: [["batchSearchCustomers", "get", "/v1/customer:batchSearch", [["id", "q", false, "form", true], ["customer_number", "q", false, "form", true], ["external_id", "q", false, "form", true], ["phone_number", "q", false, "form", true], ["email", "q", false, "form", true], ["x-trace-id", "h"]]]], v: "3.0.3" };
-  }
-});
-
-export {
-  require_phone_integration_runtime
-};

package/dist/phone-integration-JT2UAOGS.cjs

@@ -1,7 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
-
-// src/docs/phone-integration.json
-var phone_integration_default = '# Phone Integration API\n\n- **Base URL:** `https://phone-integration-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/phone-integration](https://docs.epilot.io/api/phone-integration)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.phoneIntegration.batchSearchCustomers(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/phone-integration\'\n\nconst phoneIntegrationClient = getClient()\nauthorize(phoneIntegrationClient, () => \'<token>\')\nconst { data } = await phoneIntegrationClient.batchSearchCustomers(...)\n```\n\n## Operations\n\n**phone-integration**\n- [`batchSearchCustomers`](#batchsearchcustomers)\n\n**Schemas**\n- [`CustomerBatchSearchResult`](#customerbatchsearchresult)\n- [`CustomerSearchResult`](#customersearchresult)\n- [`CustomerIdentifier`](#customeridentifier)\n- [`CustomerSummary`](#customersummary)\n- [`ErrorResponse`](#errorresponse)\n\n### `batchSearchCustomers`\n\nResolves up to 50 identifiers to epilot customers (Contacts) in one\nrequest \u2014 for example every number in an agent\'s call history.\n\n`GET /v1/customer:batchSearch`\n\n```ts\nconst { data } = await client.batchSearchCustomers({\n  id: [\'...\'],\n  customer_number: [\'...\'],\n  external_id: [\'...\'],\n  phone_number: [\'...\'],\n  email: [\'...\'],\n  x-trace-id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "identifier": {\n        "type": "id",\n        "value": "+4917012345678"\n      },\n      "status": "found",\n      "customer": {\n        "id": "dba8e5f9-8b3f-4608-b887-cd0798fce624",\n        "name": "Max Mustermann",\n        "customer_number": "4711"\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `CustomerBatchSearchResult`\n\n```ts\ntype CustomerBatchSearchResult = {\n  results: Array<{\n    identifier: {\n      type: { ... }\n      value: { ... }\n    }\n    status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n    customer?: {\n      id: { ... }\n      name: { ... }\n      customer_number?: { ... }\n    }\n  }>\n}\n```\n\n### `CustomerSearchResult`\n\n```ts\ntype CustomerSearchResult = {\n  identifier: {\n    type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n    value: string\n  }\n  status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n  customer?: {\n    id: string\n    name: string\n    customer_number?: string\n  }\n}\n```\n\n### `CustomerIdentifier`\n\n```ts\ntype CustomerIdentifier = {\n  type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n  value: string\n}\n```\n\n### `CustomerSummary`\n\nPresent when `status` is `found`\n\n```ts\ntype CustomerSummary = {\n  id: string\n  name: string\n  customer_number?: string\n}\n```\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  status: number\n  error: string\n  code?: string\n}\n```\n';
-
-
-exports.default = phone_integration_default;

package/dist/phone-integration-KORLYUBG.js

@@ -1,7 +0,0 @@
-import "./chunk-YPSWSI3M.js";
-
-// src/docs/phone-integration.json
-var phone_integration_default = '# Phone Integration API\n\n- **Base URL:** `https://phone-integration-api.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/phone-integration](https://docs.epilot.io/api/phone-integration)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.phoneIntegration.batchSearchCustomers(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/phone-integration\'\n\nconst phoneIntegrationClient = getClient()\nauthorize(phoneIntegrationClient, () => \'<token>\')\nconst { data } = await phoneIntegrationClient.batchSearchCustomers(...)\n```\n\n## Operations\n\n**phone-integration**\n- [`batchSearchCustomers`](#batchsearchcustomers)\n\n**Schemas**\n- [`CustomerBatchSearchResult`](#customerbatchsearchresult)\n- [`CustomerSearchResult`](#customersearchresult)\n- [`CustomerIdentifier`](#customeridentifier)\n- [`CustomerSummary`](#customersummary)\n- [`ErrorResponse`](#errorresponse)\n\n### `batchSearchCustomers`\n\nResolves up to 50 identifiers to epilot customers (Contacts) in one\nrequest \u2014 for example every number in an agent\'s call history.\n\n`GET /v1/customer:batchSearch`\n\n```ts\nconst { data } = await client.batchSearchCustomers({\n  id: [\'...\'],\n  customer_number: [\'...\'],\n  external_id: [\'...\'],\n  phone_number: [\'...\'],\n  email: [\'...\'],\n  x-trace-id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "identifier": {\n        "type": "id",\n        "value": "+4917012345678"\n      },\n      "status": "found",\n      "customer": {\n        "id": "dba8e5f9-8b3f-4608-b887-cd0798fce624",\n        "name": "Max Mustermann",\n        "customer_number": "4711"\n      }\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `CustomerBatchSearchResult`\n\n```ts\ntype CustomerBatchSearchResult = {\n  results: Array<{\n    identifier: {\n      type: { ... }\n      value: { ... }\n    }\n    status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n    customer?: {\n      id: { ... }\n      name: { ... }\n      customer_number?: { ... }\n    }\n  }>\n}\n```\n\n### `CustomerSearchResult`\n\n```ts\ntype CustomerSearchResult = {\n  identifier: {\n    type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n    value: string\n  }\n  status: "found" | "not_found" | "ambiguous" | "invalid" | "error"\n  customer?: {\n    id: string\n    name: string\n    customer_number?: string\n  }\n}\n```\n\n### `CustomerIdentifier`\n\n```ts\ntype CustomerIdentifier = {\n  type: "id" | "customer_number" | "external_id" | "phone_number" | "email"\n  value: string\n}\n```\n\n### `CustomerSummary`\n\nPresent when `status` is `found`\n\n```ts\ntype CustomerSummary = {\n  id: string\n  name: string\n  customer_number?: string\n}\n```\n\n### `ErrorResponse`\n\n```ts\ntype ErrorResponse = {\n  status: number\n  error: string\n  code?: string\n}\n```\n';
-export {
-  phone_integration_default as default
-};

package/dist/phone-integration.d-ChHA2oGI.d.cts

@@ -1,179 +0,0 @@
-import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
-
-/* Auto-copied from phone-integration-client */
-
-
-declare namespace Components {
-    namespace Schemas {
-        export interface CustomerBatchSearchResult {
-            /**
-             * One result per distinct identifier
-             */
-            results: CustomerSearchResult[];
-        }
-        export interface CustomerIdentifier {
-            type: "id" | "customer_number" | "external_id" | "phone_number" | "email";
-            /**
-             * The identifier as sent
-             * example:
-             * +4917012345678
-             */
-            value: string;
-        }
-        export interface CustomerSearchResult {
-            identifier: CustomerIdentifier;
-            /**
-             * - `found` — exactly one contact has the identifier; see `customer`
-             * - `not_found` — no contact the caller may see has it
-             * - `ambiguous` — several contacts share it; none is chosen
-             * - `invalid` — not a usable identifier (a phone number that does
-             *   not parse), so nothing was searched
-             * - `error` — the search for this identifier failed; try again
-             *
-             */
-            status: "found" | "not_found" | "ambiguous" | "invalid" | "error";
-            customer?: /* Present when `status` is `found` */ CustomerSummary;
-        }
-        /**
-         * Present when `status` is `found`
-         */
-        export interface CustomerSummary {
-            /**
-             * epilot entity id of the customer (Contact)
-             * example:
-             * dba8e5f9-8b3f-4608-b887-cd0798fce624
-             */
-            id: string;
-            /**
-             * The contact's title, else its first and last name; null when it has neither
-             * example:
-             * Max Mustermann
-             */
-            name: string | null;
-            /**
-             * Omitted when the contact has none
-             * example:
-             * 4711
-             */
-            customer_number?: string;
-        }
-        export interface ErrorResponse {
-            /**
-             * HTTP status code.
-             */
-            status: number;
-            /**
-             * Human-readable error message.
-             */
-            error: string;
-            /**
-             * Stable machine-readable error code, when the operation defines one.
-             */
-            code?: string;
-        }
-    }
-}
-declare namespace Paths {
-    namespace BatchSearchCustomers {
-        export interface HeaderParameters {
-            "x-trace-id"?: Parameters.XTraceId;
-        }
-        namespace Parameters {
-            export type CustomerNumber = string[];
-            export type Email = string[];
-            export type ExternalId = string[];
-            export type Id = string[];
-            export type PhoneNumber = string[];
-            export type XTraceId = string;
-        }
-        export interface QueryParameters {
-            id?: Parameters.Id;
-            customer_number?: Parameters.CustomerNumber;
-            external_id?: Parameters.ExternalId;
-            phone_number?: Parameters.PhoneNumber;
-            email?: Parameters.Email;
-        }
-        namespace Responses {
-            export type $200 = Components.Schemas.CustomerBatchSearchResult;
-            export type $400 = Components.Schemas.ErrorResponse;
-            export type $401 = Components.Schemas.ErrorResponse;
-            export type $403 = Components.Schemas.ErrorResponse;
-        }
-    }
-}
-
-
-interface OperationMethods {
-  /**
-   * batchSearchCustomers - batchSearchCustomers
-   * 
-   * Resolves up to 50 identifiers to epilot customers (Contacts) in one
-   * request — for example every number in an agent's call history.
-   * 
-   * Each identifier is an exact key of a Contact: its entity `id`, its
-   * `customer_number`, its `external_id`, one of its `email` addresses or
-   * one of its `phone` numbers. Repeat a parameter to pass several values,
-   * and combine parameters freely. Phone numbers are normalized on the
-   * server, so E.164, national and formatted forms of one number match the
-   * same contact; the other identifiers match exactly, ignoring case and
-   * surrounding whitespace.
-   * 
-   * Every distinct identifier gets its own result, so one unknown or
-   * ambiguous identifier never fails the others. Results are ordered by
-   * parameter (`id`, `customer_number`, `external_id`, `phone_number`,
-   * `email`), then as sent; match them by `identifier`.
-   * 
-   * The search runs with the caller's token: the organization and the
-   * permissions applied are the caller's own, as for entity search.
-   * 
-   */
-  'batchSearchCustomers'(
-    parameters?: Parameters<Paths.BatchSearchCustomers.QueryParameters & Paths.BatchSearchCustomers.HeaderParameters> | null,
-    data?: any,
-    config?: AxiosRequestConfig  
-  ): OperationResponse<Paths.BatchSearchCustomers.Responses.$200>
-}
-
-interface PathsDictionary {
-  ['/v1/customer:batchSearch']: {
-    /**
-     * batchSearchCustomers - batchSearchCustomers
-     * 
-     * Resolves up to 50 identifiers to epilot customers (Contacts) in one
-     * request — for example every number in an agent's call history.
-     * 
-     * Each identifier is an exact key of a Contact: its entity `id`, its
-     * `customer_number`, its `external_id`, one of its `email` addresses or
-     * one of its `phone` numbers. Repeat a parameter to pass several values,
-     * and combine parameters freely. Phone numbers are normalized on the
-     * server, so E.164, national and formatted forms of one number match the
-     * same contact; the other identifiers match exactly, ignoring case and
-     * surrounding whitespace.
-     * 
-     * Every distinct identifier gets its own result, so one unknown or
-     * ambiguous identifier never fails the others. Results are ordered by
-     * parameter (`id`, `customer_number`, `external_id`, `phone_number`,
-     * `email`), then as sent; match them by `identifier`.
-     * 
-     * The search runs with the caller's token: the organization and the
-     * permissions applied are the caller's own, as for entity search.
-     * 
-     */
-    'get'(
-      parameters?: Parameters<Paths.BatchSearchCustomers.QueryParameters & Paths.BatchSearchCustomers.HeaderParameters> | null,
-      data?: any,
-      config?: AxiosRequestConfig  
-    ): OperationResponse<Paths.BatchSearchCustomers.Responses.$200>
-  }
-}
-
-type Client = OpenAPIClient<OperationMethods, PathsDictionary>
-
-
-type CustomerBatchSearchResult = Components.Schemas.CustomerBatchSearchResult;
-type CustomerIdentifier = Components.Schemas.CustomerIdentifier;
-type CustomerSearchResult = Components.Schemas.CustomerSearchResult;
-type CustomerSummary = Components.Schemas.CustomerSummary;
-type ErrorResponse = Components.Schemas.ErrorResponse;
-
-export { type Client as C, type ErrorResponse as E, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type CustomerBatchSearchResult as c, type CustomerIdentifier as d, type CustomerSearchResult as e, type CustomerSummary as f };