@epilot/sdk 2.20.82 → 2.20.84

package/docs/targeting.md

@@ -66,6 +66,8 @@ const { data } = await targetingClient.changeCampaignStatus(...)
 - [`JobStatus`](#jobstatus)
 - [`Campaign`](#campaign)
 - [`Target`](#target)
+- [`TargetEntityFilters`](#targetentityfilters)
+- [`TargetSortItem`](#targetsortitem)
 - [`MatchCampaignParams`](#matchcampaignparams)
 - [`NextBestAction`](#nextbestaction)
 - [`DiscoverCampaignsParams`](#discovercampaignsparams)
@@ -305,6 +307,27 @@ const { data } = await client.setupCampaign(
       email: {
         automation_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84',
         template_id: 'b8c01433-5556-4e2b-aad4-6f5348d1df84'
+      },
+      entity_ui: {
+        category: 'string',
+        icon: {
+          name: 'string',
+          color: 'string'
+        },
+        title: 'string',
+        body: 'string',
+        priority: 'medium',
+        is_dismissable: true,
+        cta: {
+          type: 'journey',
+          target: 'string',
+          context_params: [
+            {
+              key: 'string',
+              value: 'string'
+            }
+          ]
+        }
       }
     }
   },
@@ -537,7 +560,17 @@ const { data } = await client.matchTargets(
         "name": "string",
         "description": "string",
         "entity_schema": "string",
-        "entity_filters": {}
+        "entity_filters": {
+          "filter": {},
+          "search": "string",
+          "sort": [
+            {
+              "key": "billing_address.postal_code",
+              "order": "asc"
+            }
+          ],
+          "limit": 1
+        }
       }
     }
   ]
@@ -552,6 +585,7 @@ const { data } = await client.matchTargets(
 
 Transform target filters into Lucene queries for the provided target IDs.
 Returns the transformed query string for each target along with any errors encountered.
+If the target defines a sort order or 
 
 `POST /v1/target/queries`
 
@@ -573,7 +607,9 @@ const { data } = await client.getTargetQueries(
     {
       "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",
       "query": "string",
-      "error": "string"
+      "error": "string",
+      "sort": ["billing_date:desc", "_title.keyword:asc", "_id:desc"],
+      "limit": 1
     }
   ]
 }
@@ -1218,7 +1254,42 @@ type Target = {
   name?: string
   description?: string
   entity_schema?: string
-  entity_filters?: Record<string, unknown>
+  entity_filters?: {
+    filter?: Record<string, unknown>
+    search?: string
+    sort?: Array<{
+      key: { ... }
+      order: { ... }
+    }>
+    limit?: number
+  }
+}
+```
+
+### `TargetEntityFilters`
+
+Search state of the target. `filter` and `search` use the same shape as the search state of entity views.
+Besides the filters, it optionally defines the order and maximum number of results.
+
+
+```ts
+type TargetEntityFilters = {
+  filter?: Record<string, unknown>
+  search?: string
+  sort?: Array<{
+    key: string
+    order: "asc" | "desc"
+  }>
+  limit?: number
+}
+```
+
+### `TargetSortItem`
+
+```ts
+type TargetSortItem = {
+  key: string
+  order: "asc" | "desc"
 }
 ```
 
@@ -1327,6 +1398,8 @@ type TargetQueryResult = {
   target_id: string // uuid
   query: string
   error?: string
+  sort?: string[]
+  limit?: number
 }
 ```
 
@@ -1541,6 +1614,15 @@ type SetupCampaignRequest = {
       automation_id?: { ... }
       template_id?: { ... }
     }
+    entity_ui?: {
+      category?: { ... }
+      icon?: { ... }
+      title: { ... }
+      body?: { ... }
+      priority?: { ... }
+      is_dismissable?: { ... }
+      cta: { ... }
+    }
   }
 }
 ```
@@ -1576,6 +1658,15 @@ type SetupTariffChangeCampaignRequest = {
       automation_id?: { ... }
       template_id?: { ... }
     }
+    entity_ui?: {
+      category?: { ... }
+      icon?: { ... }
+      title: { ... }
+      body?: { ... }
+      priority?: { ... }
+      is_dismissable?: { ... }
+      cta: { ... }
+    }
   }
 }
 ```

package/package.json

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

package/dist/chunk-NHA2IXWN.cjs

@@ -1,14 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});
-
-var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
-
-// src/definitions/phone-integration-runtime.json
-var require_phone_integration_runtime = _chunkNJK5F5TFcjs.__commonJS.call(void 0, {
-  "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"]]], ["getManagerStatus", "get", "/v1/manager/status"], ["listPhoneAgents", "get", "/v1/manager/agents"], ["assignPhoneAgent", "post", "/v1/manager/agents", null, 1], ["removePhoneAgent", "delete", "/v1/manager/agents/{user_id}"], ["listProviderSetups", "get", "/v1/operator/provider-setups"], ["getProviderSetup", "get", "/v1/operator/organizations/{org_id}/provider"], ["setupProvider", "post", "/v1/operator/organizations/{org_id}/provider:setup", null, 1]], v: "3.0.3", pp: { "/v1/manager/agents/{user_id}": [["user_id", "p", true]], "/v1/operator/organizations/{org_id}/provider": [["org_id", "p", true]], "/v1/operator/organizations/{org_id}/provider:setup": [["org_id", "p", true]] } };
-  }
-});
-
-
-
-exports.require_phone_integration_runtime = require_phone_integration_runtime;

package/dist/chunk-QFTXKO2I.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"]]], ["getManagerStatus", "get", "/v1/manager/status"], ["listPhoneAgents", "get", "/v1/manager/agents"], ["assignPhoneAgent", "post", "/v1/manager/agents", null, 1], ["removePhoneAgent", "delete", "/v1/manager/agents/{user_id}"], ["listProviderSetups", "get", "/v1/operator/provider-setups"], ["getProviderSetup", "get", "/v1/operator/organizations/{org_id}/provider"], ["setupProvider", "post", "/v1/operator/organizations/{org_id}/provider:setup", null, 1]], v: "3.0.3", pp: { "/v1/manager/agents/{user_id}": [["user_id", "p", true]], "/v1/operator/organizations/{org_id}/provider": [["org_id", "p", true]], "/v1/operator/organizations/{org_id}/provider:setup": [["org_id", "p", true]] } };
-  }
-});
-
-export {
-  require_phone_integration_runtime
-};

package/dist/phone-integration-ARSGAHNJ.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**manager**\n- [`getManagerStatus`](#getmanagerstatus)\n- [`listPhoneAgents`](#listphoneagents)\n- [`assignPhoneAgent`](#assignphoneagent)\n- [`removePhoneAgent`](#removephoneagent)\n\n**operator**\n- [`listProviderSetups`](#listprovidersetups)\n- [`getProviderSetup`](#getprovidersetup)\n- [`setupProvider`](#setupprovider)\n\n**Schemas**\n- [`ManagerStatus`](#managerstatus)\n- [`PhoneAgent`](#phoneagent)\n- [`AssignPhoneAgentRequest`](#assignphoneagentrequest)\n- [`ProviderSetup`](#providersetup)\n- [`ProviderSetupSummary`](#providersetupsummary)\n- [`ProviderSetupRequest`](#providersetuprequest)\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### `getManagerStatus`\n\nWhether the caller\'s organization is ready for phone agents: the telephony provider tenant\nexists and is configured. The control center shows a "not set up" state when `ready` is false.\nRequires `phon\n\n`GET /v1/manager/status`\n\n```ts\nconst { data } = await client.getManagerStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "ready": true,\n  "reasons": ["provider_tenant_missing"]\n}\n```\n\n</details>\n\n---\n\n### `listPhoneAgents`\n\nOrganization members who hold the phone (`phone:use`), each joined with the provider user behind\nthem. Requires `phone:manage`.\n\n`GET /v1/manager/agents`\n\n```ts\nconst { data } = await client.listPhoneAgents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "user_id": "string",\n      "email": "string",\n      "display_name": "string",\n      "status": "active",\n      "provider_user_id": "string",\n      "provider_roles": ["string"],\n      "assigned_at": "1970-01-01T00:00:00.000Z",\n      "assigned_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `assignPhoneAgent`\n\nGives an organization member the phone. In order: the member is verified with user-api, their\npairwise subject for the provider is read from identity-api, the provider user is created (or\nfound) bound\n\n`POST /v1/manager/agents`\n\n```ts\nconst { data } = await client.assignPhoneAgent(\n  null,\n  {\n    user_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "string",\n  "email": "string",\n  "display_name": "string",\n  "status": "active",\n  "provider_user_id": "string",\n  "provider_roles": ["string"],\n  "assigned_at": "1970-01-01T00:00:00.000Z",\n  "assigned_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removePhoneAgent`\n\nTakes the phone away from a member: the `phone_agent` role is removed first, then the provider\nuser is deactivated (never deleted: call history keeps referring to it). Requires `phone:manage`.\n\n`DELETE /v1/manager/agents/{user_id}`\n\n```ts\nconst { data } = await client.removePhoneAgent({\n  user_id: \'example\',\n})\n```\n\n---\n\n### `listProviderSetups`\n\nEvery organization that has a telephony provider tenant, for the admin portal\'s overview: the\nprovider\'s sub-accounts (one per organization, keyed by the organization id) joined with this\nservice\'s se\n\n`GET /v1/operator/provider-setups`\n\n```ts\nconst { data } = await client.listProviderSetups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "org_id": "string",\n      "provider": "babelforce",\n      "ready": true,\n      "setup_recorded": true,\n      "tenant": {\n        "id": "string",\n        "name": "string",\n        "org_key": "string"\n      },\n      "sso_identity_client_id": "string",\n      "last_setup_by": "string",\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getProviderSetup`\n\nWhat has been set up at the telephony provider for this organization.\n\n`GET /v1/operator/organizations/{org_id}/provider`\n\n```ts\nconst { data } = await client.getProviderSetup({\n  org_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `setupProvider`\n\nPrepares the telephony provider for an organization, idempotently and in order: the provider\ntenant (Babelforce sub-account keyed by the organization id), its SCIM configuration with role\nmanagement o\n\n`POST /v1/operator/organizations/{org_id}/provider:setup`\n\n```ts\nconst { data } = await client.setupProvider(\n  {\n    org_id: \'example\',\n  },\n  {\n    account_name: \'string\',\n    identity_client_id: \'string\',\n    identity_client_secret: \'stringstring\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ManagerStatus`\n\n```ts\ntype ManagerStatus = {\n  provider: "babelforce"\n  ready: boolean\n  reasons: "provider_tenant_missing" | "sso_not_configured" | "scim_not_configured" | "identity_enablement_missing"[]\n}\n```\n\n### `PhoneAgent`\n\n```ts\ntype PhoneAgent = {\n  user_id: string\n  email: string\n  display_name?: string\n  status: "active" | "pending" | "disabled" | "missing_provider" | "missing_role"\n  provider_user_id?: string\n  provider_roles?: string[]\n  assigned_at?: string // date-time\n  assigned_by?: string\n}\n```\n\n### `AssignPhoneAgentRequest`\n\n```ts\ntype AssignPhoneAgentRequest = {\n  user_id: string\n}\n```\n\n### `ProviderSetup`\n\n```ts\ntype ProviderSetup = {\n  provider: "babelforce"\n  org_id: string\n  ready: boolean\n  tenant: {\n    id: string\n    name: string\n    org_key: string\n    created_at?: string // date-time\n  }\n  scim: {\n    configured: boolean\n    roles_enabled: boolean\n  }\n  sso: {\n    configured: boolean\n    identity_client_id?: string\n    configured_at?: string // date-time\n  }\n  last_setup_by?: string\n}\n```\n\n### `ProviderSetupSummary`\n\nOne organization\'s provider setup, as listed in the overview (no live SCIM or SSO reads).\n\n```ts\ntype ProviderSetupSummary = {\n  org_id: string\n  provider: "babelforce"\n  ready: boolean\n  setup_recorded: boolean\n  tenant: {\n    id: string\n    name: string\n    org_key: string\n  }\n  sso_identity_client_id?: string\n  last_setup_by?: string\n  updated_at?: string // date-time\n}\n```\n\n### `ProviderSetupRequest`\n\n```ts\ntype ProviderSetupRequest = {\n  account_name?: string\n  identity_client_id: string\n  identity_client_secret: string\n}\n```\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-MGH7LYID.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**manager**\n- [`getManagerStatus`](#getmanagerstatus)\n- [`listPhoneAgents`](#listphoneagents)\n- [`assignPhoneAgent`](#assignphoneagent)\n- [`removePhoneAgent`](#removephoneagent)\n\n**operator**\n- [`listProviderSetups`](#listprovidersetups)\n- [`getProviderSetup`](#getprovidersetup)\n- [`setupProvider`](#setupprovider)\n\n**Schemas**\n- [`ManagerStatus`](#managerstatus)\n- [`PhoneAgent`](#phoneagent)\n- [`AssignPhoneAgentRequest`](#assignphoneagentrequest)\n- [`ProviderSetup`](#providersetup)\n- [`ProviderSetupSummary`](#providersetupsummary)\n- [`ProviderSetupRequest`](#providersetuprequest)\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### `getManagerStatus`\n\nWhether the caller\'s organization is ready for phone agents: the telephony provider tenant\nexists and is configured. The control center shows a "not set up" state when `ready` is false.\nRequires `phon\n\n`GET /v1/manager/status`\n\n```ts\nconst { data } = await client.getManagerStatus()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "ready": true,\n  "reasons": ["provider_tenant_missing"]\n}\n```\n\n</details>\n\n---\n\n### `listPhoneAgents`\n\nOrganization members who hold the phone (`phone:use`), each joined with the provider user behind\nthem. Requires `phone:manage`.\n\n`GET /v1/manager/agents`\n\n```ts\nconst { data } = await client.listPhoneAgents()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "user_id": "string",\n      "email": "string",\n      "display_name": "string",\n      "status": "active",\n      "provider_user_id": "string",\n      "provider_roles": ["string"],\n      "assigned_at": "1970-01-01T00:00:00.000Z",\n      "assigned_by": "string"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `assignPhoneAgent`\n\nGives an organization member the phone. In order: the member is verified with user-api, their\npairwise subject for the provider is read from identity-api, the provider user is created (or\nfound) bound\n\n`POST /v1/manager/agents`\n\n```ts\nconst { data } = await client.assignPhoneAgent(\n  null,\n  {\n    user_id: \'string\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "user_id": "string",\n  "email": "string",\n  "display_name": "string",\n  "status": "active",\n  "provider_user_id": "string",\n  "provider_roles": ["string"],\n  "assigned_at": "1970-01-01T00:00:00.000Z",\n  "assigned_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `removePhoneAgent`\n\nTakes the phone away from a member: the `phone_agent` role is removed first, then the provider\nuser is deactivated (never deleted: call history keeps referring to it). Requires `phone:manage`.\n\n`DELETE /v1/manager/agents/{user_id}`\n\n```ts\nconst { data } = await client.removePhoneAgent({\n  user_id: \'example\',\n})\n```\n\n---\n\n### `listProviderSetups`\n\nEvery organization that has a telephony provider tenant, for the admin portal\'s overview: the\nprovider\'s sub-accounts (one per organization, keyed by the organization id) joined with this\nservice\'s se\n\n`GET /v1/operator/provider-setups`\n\n```ts\nconst { data } = await client.listProviderSetups()\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "results": [\n    {\n      "org_id": "string",\n      "provider": "babelforce",\n      "ready": true,\n      "setup_recorded": true,\n      "tenant": {\n        "id": "string",\n        "name": "string",\n        "org_key": "string"\n      },\n      "sso_identity_client_id": "string",\n      "last_setup_by": "string",\n      "updated_at": "1970-01-01T00:00:00.000Z"\n    }\n  ]\n}\n```\n\n</details>\n\n---\n\n### `getProviderSetup`\n\nWhat has been set up at the telephony provider for this organization.\n\n`GET /v1/operator/organizations/{org_id}/provider`\n\n```ts\nconst { data } = await client.getProviderSetup({\n  org_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n### `setupProvider`\n\nPrepares the telephony provider for an organization, idempotently and in order: the provider\ntenant (Babelforce sub-account keyed by the organization id), its SCIM configuration with role\nmanagement o\n\n`POST /v1/operator/organizations/{org_id}/provider:setup`\n\n```ts\nconst { data } = await client.setupProvider(\n  {\n    org_id: \'example\',\n  },\n  {\n    account_name: \'string\',\n    identity_client_id: \'string\',\n    identity_client_secret: \'stringstring\'\n  },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n  "provider": "babelforce",\n  "org_id": "string",\n  "ready": true,\n  "tenant": {\n    "id": "string",\n    "name": "string",\n    "org_key": "string",\n    "created_at": "1970-01-01T00:00:00.000Z"\n  },\n  "scim": {\n    "configured": true,\n    "roles_enabled": true\n  },\n  "sso": {\n    "configured": true,\n    "identity_client_id": "string",\n    "configured_at": "1970-01-01T00:00:00.000Z"\n  },\n  "last_setup_by": "string"\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `ManagerStatus`\n\n```ts\ntype ManagerStatus = {\n  provider: "babelforce"\n  ready: boolean\n  reasons: "provider_tenant_missing" | "sso_not_configured" | "scim_not_configured" | "identity_enablement_missing"[]\n}\n```\n\n### `PhoneAgent`\n\n```ts\ntype PhoneAgent = {\n  user_id: string\n  email: string\n  display_name?: string\n  status: "active" | "pending" | "disabled" | "missing_provider" | "missing_role"\n  provider_user_id?: string\n  provider_roles?: string[]\n  assigned_at?: string // date-time\n  assigned_by?: string\n}\n```\n\n### `AssignPhoneAgentRequest`\n\n```ts\ntype AssignPhoneAgentRequest = {\n  user_id: string\n}\n```\n\n### `ProviderSetup`\n\n```ts\ntype ProviderSetup = {\n  provider: "babelforce"\n  org_id: string\n  ready: boolean\n  tenant: {\n    id: string\n    name: string\n    org_key: string\n    created_at?: string // date-time\n  }\n  scim: {\n    configured: boolean\n    roles_enabled: boolean\n  }\n  sso: {\n    configured: boolean\n    identity_client_id?: string\n    configured_at?: string // date-time\n  }\n  last_setup_by?: string\n}\n```\n\n### `ProviderSetupSummary`\n\nOne organization\'s provider setup, as listed in the overview (no live SCIM or SSO reads).\n\n```ts\ntype ProviderSetupSummary = {\n  org_id: string\n  provider: "babelforce"\n  ready: boolean\n  setup_recorded: boolean\n  tenant: {\n    id: string\n    name: string\n    org_key: string\n  }\n  sso_identity_client_id?: string\n  last_setup_by?: string\n  updated_at?: string // date-time\n}\n```\n\n### `ProviderSetupRequest`\n\n```ts\ntype ProviderSetupRequest = {\n  account_name?: string\n  identity_client_id: string\n  identity_client_secret: string\n}\n```\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
-};