@epilot/sdk 2.20.79 → 2.20.81

package/docs/file.md

@@ -41,6 +41,10 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`getCurrentFileSummaryJob`](#getcurrentfilesummaryjob)
 - [`getFileSummaryJob`](#getfilesummaryjob)
 - [`generateFileSummary`](#generatefilesummary)
+- [`createFileAttributeSuggestionJob`](#createfileattributesuggestionjob)
+- [`getLatestFileAttributeSuggestions`](#getlatestfileattributesuggestions)
+- [`getFileAttributeSuggestionJob`](#getfileattributesuggestionjob)
+- [`updateFileAttributeSuggestionStatus`](#updatefileattributesuggestionstatus)
 - [`getFileText`](#getfiletext)
 - [`validateFile`](#validatefile)
 - [`verifyCustomDownloadUrl`](#verifycustomdownloadurl)
@@ -83,6 +87,13 @@ const { data } = await fileClient.uploadFileV2(...)
 - [`FileSummaryFeedback`](#filesummaryfeedback)
 - [`FileSummaryFeedbackResponse`](#filesummaryfeedbackresponse)
 - [`PutFileSummaryFeedbackRequest`](#putfilesummaryfeedbackrequest)
+- [`FileAttributeSuggestionJobStatus`](#fileattributesuggestionjobstatus)
+- [`FileAttributeSuggestion`](#fileattributesuggestion)
+- [`FileAttributeSuggestionsPayload`](#fileattributesuggestionspayload)
+- [`FileAttributeSuggestionJob`](#fileattributesuggestionjob)
+- [`CreateFileAttributeSuggestionJobRequest`](#createfileattributesuggestionjobrequest)
+- [`UpdateFileAttributeSuggestionStatusRequest`](#updatefileattributesuggestionstatusrequest)
+- [`FileAttributeSuggestionError`](#fileattributesuggestionerror)
 - [`FileTextStatus`](#filetextstatus)
 - [`FileValidationRequest`](#filevalidationrequest)
 - [`FileValidationFileReference`](#filevalidationfilereference)
@@ -759,6 +770,211 @@ const { data } = await client.generateFileSummary({
 
 ---
 
+### `createFileAttributeSuggestionJob`
+
+Start an auto-fill job that reads the file's extracted text and suggests values for the related entity's attributes. Requires `entity:view` on the file and on the related entity. Returns 404 with `err
+
+`POST /v1/files/{id}/attribute-suggestion-jobs`
+
+```ts
+const { data } = await client.createFileAttributeSuggestionJob(
+  {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+  },
+  {
+    entity_slug: 'opportunity',
+    entity_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
+  },
+)
+```
+
+---
+
+### `getLatestFileAttributeSuggestions`
+
+Get the most recent attribute suggestion job of any status for the file and the given entity. Returns 404 with `error_code: no_file_attribute_suggestions_job` when auto-fill has not run yet.
+
+`GET /v1/files/{id}/attribute-suggestion-jobs/latest`
+
+```ts
+const { data } = await client.getLatestFileAttributeSuggestions({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+  entity_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "jobId": "string",
+  "jobStatus": {
+    "status": "INITIATED",
+    "progress": 0,
+    "error": "string"
+  },
+  "payload": {
+    "file_id": "string",
+    "entity_id": "string",
+    "entity_slug": "string",
+    "generated_by": "string",
+    "generated_at": 0,
+    "suggestions": [
+      {
+        "attribute_name": "string",
+        "attribute_label": "string",
+        "attribute_type": "date",
+        "suggested_value": "string",
+        "confidence": "high",
+        "source_page": 0,
+        "evidence": "string",
+        "status": "suggested",
+        "status_updated_by": "string",
+        "status_updated_at": 0,
+        "discard_reason": "string",
+        "is_copied": true,
+        "copied_by": "string",
+        "copied_at": 0,
+        "suggestion_type": "new_value"
+      }
+    ]
+  },
+  "createdAt": 0,
+  "updatedAt": 0
+}
+```
+
+</details>
+
+---
+
+### `getFileAttributeSuggestionJob`
+
+Get an attribute suggestion job of the file. Poll until `jobStatus.status` is `COMPLETED` or `FAILED`.
+
+`GET /v1/files/{id}/attribute-suggestion-jobs/{job_id}`
+
+```ts
+const { data } = await client.getFileAttributeSuggestionJob({
+  id: '123e4567-e89b-12d3-a456-426614174000',
+  job_id: 'example',
+})
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "jobId": "string",
+  "jobStatus": {
+    "status": "INITIATED",
+    "progress": 0,
+    "error": "string"
+  },
+  "payload": {
+    "file_id": "string",
+    "entity_id": "string",
+    "entity_slug": "string",
+    "generated_by": "string",
+    "generated_at": 0,
+    "suggestions": [
+      {
+        "attribute_name": "string",
+        "attribute_label": "string",
+        "attribute_type": "date",
+        "suggested_value": "string",
+        "confidence": "high",
+        "source_page": 0,
+        "evidence": "string",
+        "status": "suggested",
+        "status_updated_by": "string",
+        "status_updated_at": 0,
+        "discard_reason": "string",
+        "is_copied": true,
+        "copied_by": "string",
+        "copied_at": 0,
+        "suggestion_type": "new_value"
+      }
+    ]
+  },
+  "createdAt": 0,
+  "updatedAt": 0
+}
+```
+
+</details>
+
+---
+
+### `updateFileAttributeSuggestionStatus`
+
+Record that suggestions were accepted, discarded or copied. Only the suggestion entries named in the request change; unknown attribute names are ignored. Applying a value to the entity stays with the 
+
+`PATCH /v1/files/{id}/attribute-suggestion-jobs/{job_id}`
+
+```ts
+const { data } = await client.updateFileAttributeSuggestionStatus(
+  {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+    job_id: 'example',
+  },
+  {
+    suggestionStatusUpdates: [
+      {},
+      {}
+    ]
+  },
+)
+```
+
+<details>
+<summary>Response</summary>
+
+```json
+{
+  "jobId": "string",
+  "jobStatus": {
+    "status": "INITIATED",
+    "progress": 0,
+    "error": "string"
+  },
+  "payload": {
+    "file_id": "string",
+    "entity_id": "string",
+    "entity_slug": "string",
+    "generated_by": "string",
+    "generated_at": 0,
+    "suggestions": [
+      {
+        "attribute_name": "string",
+        "attribute_label": "string",
+        "attribute_type": "date",
+        "suggested_value": "string",
+        "confidence": "high",
+        "source_page": 0,
+        "evidence": "string",
+        "status": "suggested",
+        "status_updated_by": "string",
+        "status_updated_at": 0,
+        "discard_reason": "string",
+        "is_copied": true,
+        "copied_by": "string",
+        "copied_at": 0,
+        "suggestion_type": "new_value"
+      }
+    ]
+  },
+  "createdAt": 0,
+  "updatedAt": 0
+}
+```
+
+</details>
+
+---
+
 ### `getFileText`
 
 Get the plain-text representation of a file entity. Returns status `not_ready` while text is being prepared and `unsupported` when text is unavailable for the file or organization.
@@ -928,6 +1144,7 @@ const { data } = await client.previewPublicFile({
   version: 1,
   w: 1,
   h: 1,
+  keep_original: true,
   org_id: 'example',
 })
 ```
@@ -1487,6 +1704,133 @@ type PutFileSummaryFeedbackRequest = {
 }
 ```
 
+### `FileAttributeSuggestionJobStatus`
+
+```ts
+type FileAttributeSuggestionJobStatus = {
+  status: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED"
+  progress: number
+  error?: string
+}
+```
+
+### `FileAttributeSuggestion`
+
+```ts
+type FileAttributeSuggestion = {
+  attribute_name?: string
+  attribute_label?: string
+  attribute_type?: "date" | "number" | "boolean" | "select" | "string"
+  suggested_value?: string | number | boolean
+  confidence?: "high" | "medium" | "low"
+  source_page?: number
+  evidence?: string
+  status?: "suggested" | "accepted" | "discarded"
+  status_updated_by?: string
+  status_updated_at?: number
+  discard_reason?: string
+  is_copied?: boolean
+  copied_by?: string
+  copied_at?: number
+  suggestion_type?: "new_value" | "update"
+}
+```
+
+### `FileAttributeSuggestionsPayload`
+
+```ts
+type FileAttributeSuggestionsPayload = {
+  file_id: string
+  entity_id: string
+  entity_slug: string
+  generated_by?: string
+  generated_at?: number
+  suggestions: Array<{
+    attribute_name?: string
+    attribute_label?: string
+    attribute_type?: "date" | "number" | "boolean" | "select" | "string"
+    suggested_value?: string | number | boolean
+    confidence?: "high" | "medium" | "low"
+    source_page?: number
+    evidence?: string
+    status?: "suggested" | "accepted" | "discarded"
+    status_updated_by?: string
+    status_updated_at?: number
+    discard_reason?: string
+    is_copied?: boolean
+    copied_by?: string
+    copied_at?: number
+    suggestion_type?: "new_value" | "update"
+  }>
+}
+```
+
+### `FileAttributeSuggestionJob`
+
+```ts
+type FileAttributeSuggestionJob = {
+  jobId: string
+  jobStatus: {
+    status: "INITIATED" | "IN_PROGRESS" | "COMPLETED" | "FAILED"
+    progress: number
+    error?: string
+  }
+  payload: {
+    file_id: string
+    entity_id: string
+    entity_slug: string
+    generated_by?: string
+    generated_at?: number
+    suggestions: Array<{
+      attribute_name?: { ... }
+      attribute_label?: { ... }
+      attribute_type?: { ... }
+      suggested_value?: { ... }
+      confidence?: { ... }
+      source_page?: { ... }
+      evidence?: { ... }
+      status?: { ... }
+      status_updated_by?: { ... }
+      status_updated_at?: { ... }
+      discard_reason?: { ... }
+      is_copied?: { ... }
+      copied_by?: { ... }
+      copied_at?: { ... }
+      suggestion_type?: { ... }
+    }>
+  }
+  createdAt: number
+  updatedAt: number
+}
+```
+
+### `CreateFileAttributeSuggestionJobRequest`
+
+```ts
+type CreateFileAttributeSuggestionJobRequest = {
+  entity_slug: string
+  entity_id: string // uuid
+}
+```
+
+### `UpdateFileAttributeSuggestionStatusRequest`
+
+```ts
+type UpdateFileAttributeSuggestionStatusRequest = {
+  suggestionStatusUpdates: unknown | unknown[]
+}
+```
+
+### `FileAttributeSuggestionError`
+
+```ts
+type FileAttributeSuggestionError = {
+  status?: number
+  error?: string
+  error_code?: "entity_or_schema_unavailable" | "file_not_extracted" | "extraction_unsupported" | "extraction_failed" | "extraction_status_unavailable" | "processing_enqueue_failed" | "no_file_attribute_suggestions_job" | "job_not_found"
+}
+```
+
 ### `FileTextStatus`
 
 Availability of the plain-text representation for a file entity.

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.81",
   "description": "JavaScript/TypeScript SDK for epilot APIs",
   "type": "module",
   "main": "./dist/index.cjs",