@proteos/sdk 0.19.0 → 0.20.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteos/sdk",
-  "version": "0.19.0",
+  "version": "0.20.1",
   "license": "Apache-2.0",
   "description": "TypeScript SDK for the Proteos platform",
   "repository": {

package/src/auth/platform-entities.ts

@@ -62,6 +62,7 @@ export const PLATFORM_ENTITIES: readonly PlatformEntity[] = [
   { slug: 'messages', name: 'Messages' },
   { slug: 'agent-listeners', name: 'Agent Listeners' },
   { slug: 'transcriptions', name: 'Transcriptions' },
+  { slug: 'glossary-terms', name: 'Glossary Terms' },
   // Connectors (connector-service). `connections` above is shared; this is the
   // manifest catalog.
   { slug: 'connectors', name: 'Connectors' },

package/src/conversation/index.ts

@@ -10,9 +10,13 @@ import type {
   Conversation,
   CreateAgentListenerRequest,
   CreateConnectionRequest,
+  CreateGlossaryTermRequest,
+  DispatchMeetingBotRequest,
+  GlossaryTerm,
   InstallConnectionResponse,
   ListAgentListenersQuery,
   ListConnectionsQuery,
+  ListGlossaryTermsQuery,
   ListConversationsQuery,
   ListMessagesQuery,
   ListParticipantsQuery,
@@ -27,6 +31,7 @@ import type {
   UnreadCounts,
   UpdateAgentListenerRequest,
   UpdateConnectionRequest,
+  UpdateGlossaryTermRequest,
 } from './types.js'
 
 const CONVERSATION_BASE_PATH = '/conversations/v1'
@@ -46,7 +51,11 @@ export class ConversationClient {
   readonly conversations: ConversationService
   readonly messages: MessageService
   readonly agentListeners: AgentListenerService
+  /** Per-org glossary: custom vocabulary that boosts transcription accuracy. */
+  readonly glossaryTerms: GlossaryTermService
   readonly transcriptions: TranscriptionService
+  /** Meeting bots (Ava): dispatch into a meeting URL, remove from a meeting. */
+  readonly meetings: MeetingService
   /** Realtime speech-to-text (dictation) — moved here from agent-service. */
   readonly voice: VoiceService
 
@@ -55,11 +64,37 @@ export class ConversationClient {
     this.conversations = new ConversationServiceImpl(client)
     this.messages = new MessageServiceImpl(client)
     this.agentListeners = new AgentListenerServiceImpl(client)
+    this.glossaryTerms = new GlossaryTermServiceImpl(client)
     this.transcriptions = new TranscriptionServiceImpl(client)
+    this.meetings = new MeetingServiceImpl(client)
     this.voice = new VoiceServiceImpl(client)
   }
 }
 
+/** Meeting bots (Ava) — dispatch by meeting URL and removal. */
+export interface MeetingService {
+  /**
+   * Send Ava to a meeting URL. Resolves with the pre-minted meeting
+   * conversation (channel = the platform classified from the URL); transcript
+   * turns then stream in as inbound messages while the meeting runs.
+   */
+  dispatch(request: DispatchMeetingBotRequest): Promise<Conversation>
+  /** Make the bot leave the meeting and end the conversation (by conversation id). */
+  remove(conversationId: string): Promise<Conversation>
+}
+
+class MeetingServiceImpl implements MeetingService {
+  constructor(private readonly client: ProteosClient) {}
+
+  dispatch(request: DispatchMeetingBotRequest): Promise<Conversation> {
+    return this.client.request('POST', `${CONVERSATION_BASE_PATH}/meetings`, request)
+  }
+
+  remove(conversationId: string): Promise<Conversation> {
+    return this.client.request('DELETE', `${CONVERSATION_BASE_PATH}/meetings/${encodeURIComponent(conversationId)}`)
+  }
+}
+
 /** Configured integration instances (Slack workspace, Gmail grant, …). */
 export interface ConnectionService {
   list(query?: ListConnectionsQuery): Promise<ListResponse<Connection>>
@@ -249,6 +284,44 @@ class AgentListenerServiceImpl implements AgentListenerService {
   }
 }
 
+/**
+ * Per-org glossary: custom-vocabulary terms that boost transcription accuracy.
+ * A term feeds the transcription provider's keyterm prompting; `priority` ranks
+ * a term (prioritized terms are injected first, then unprioritized), which
+ * decides the top 100 sent when an org stores more than the provider's cap.
+ */
+export interface GlossaryTermService {
+  list(query?: ListGlossaryTermsQuery): Promise<ListResponse<GlossaryTerm>>
+  get(id: string): Promise<GlossaryTerm>
+  create(request: CreateGlossaryTermRequest): Promise<GlossaryTerm>
+  update(id: string, request: UpdateGlossaryTermRequest): Promise<GlossaryTerm>
+  delete(id: string): Promise<void>
+}
+
+class GlossaryTermServiceImpl implements GlossaryTermService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(query: ListGlossaryTermsQuery = {}): Promise<ListResponse<GlossaryTerm>> {
+    return this.client.requestWithQuery('GET', `${CONVERSATION_BASE_PATH}/glossary-terms`, query)
+  }
+
+  get(id: string): Promise<GlossaryTerm> {
+    return this.client.request('GET', `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`)
+  }
+
+  create(request: CreateGlossaryTermRequest): Promise<GlossaryTerm> {
+    return this.client.request('POST', `${CONVERSATION_BASE_PATH}/glossary-terms`, request)
+  }
+
+  update(id: string, request: UpdateGlossaryTermRequest): Promise<GlossaryTerm> {
+    return this.client.request('PATCH', `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`, request)
+  }
+
+  async delete(id: string): Promise<void> {
+    await this.client.request('DELETE', `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`)
+  }
+}
+
 /** Batch transcription of stored audio files + materialization. */
 export interface TranscriptionService {
   /**

package/src/conversation/types.ts

@@ -5,16 +5,26 @@
 
 import type { FileRef } from '../types/common.js'
 
-/** Platform medium a conversation lives on (closed enum; platform identity). */
+/**
+ * Platform medium a conversation lives on (closed enum; platform identity).
+ * Where a provider brand spans both a chat product and a meeting platform the
+ * channel is suffixed -chat / -meeting (teams-chat vs teams-meeting). The
+ * *-meeting channels are the platforms the Ava meeting-bot family serves;
+ * `meeting` stays the generic fallback for unclassified platforms.
+ */
 export type Channel =
   | 'slack'
   | 'email'
   | 'linkedin'
   | 'sms'
-  | 'teams'
+  | 'teams-chat'
   | 'telegram'
   | 'whatsapp'
   | 'meeting'
+  | 'zoom-meeting'
+  | 'google-meet'
+  | 'teams-meeting'
+  | 'webex-meeting'
   | 'adhoc'
   | 'instagram'
   | 'messenger'
@@ -24,7 +34,9 @@ export type Channel =
  * Concrete integration serving a channel (typed union — one value per shipped
  * connector; runtime availability is decided by the service's registry).
  * The unipile-* family serves the six messaging systems aggregated through
- * Unipile — one key per messaging system.
+ * Unipile — one key per messaging system. The meeting keys are the Ava
+ * meeting-bot family: adhoc-meeting dispatches by meeting URL; the calendar
+ * keys auto-join through a user's connected calendar.
  */
 export type ConnectorKey =
   | 'slack'
@@ -36,13 +48,17 @@ export type ConnectorKey =
   | 'unipile-instagram'
   | 'unipile-messenger'
   | 'unipile-x'
+  | 'adhoc-meeting'
+  | 'google-calendar-meeting'
+  | 'microsoft-calendar-meeting'
 
 /**
  * Who operates the integration mechanics behind a connector: Proteos' own
- * integration (native) or an account aggregated through Unipile (unipile).
- * Computed on connection reads; the UI groups the connector catalog by it.
+ * integration (native), an account aggregated through Unipile (unipile), or
+ * the Ava meeting-bot family (ava). Computed on connection reads; the UI
+ * groups the connector catalog by it.
  */
-export type ConnectorProvider = 'native' | 'unipile'
+export type ConnectorProvider = 'native' | 'unipile' | 'ava'
 
 export type MessageDirection = 'inbound' | 'outbound'
 export type MessageStatus = 'received' | 'pending' | 'sent' | 'failed'
@@ -325,6 +341,12 @@ export interface AgentListener {
   agent_key: string
   trigger_type: AgentListenerTriggerType
   trigger_config: AgentListenerTriggerConfig
+  /**
+   * When set, gates the listener behind a wake word: the trigger stays dormant
+   * until a message containing this phrase starts a session; once a session is
+   * connected the trigger drives it normally. Empty/absent ⇒ no gate.
+   */
+  wake_phrase?: string
   /** The user the dispatcher acts as when driving the agent. */
   acting_user: UserRef
   is_enabled: boolean
@@ -396,6 +418,8 @@ export interface CreateAgentListenerRequest {
   agent_key: string
   trigger_type: AgentListenerTriggerType
   trigger_config?: AgentListenerTriggerConfig
+  /** Gate the listener behind a wake word; omit or leave empty for no gate. */
+  wake_phrase?: string
   /** A bare user id; the service wraps it into a person UserRef. */
   acting_user_id: string
   /** Omit to default to enabled. */
@@ -408,11 +432,52 @@ export interface UpdateAgentListenerRequest {
   agent_key?: string
   trigger_type?: AgentListenerTriggerType
   trigger_config?: AgentListenerTriggerConfig
+  /** Set to gate the listener; pass "" to clear an existing wake phrase. */
+  wake_phrase?: string
   acting_user_id?: string
   is_enabled?: boolean
   priority?: number
 }
 
+/**
+ * A per-org glossary term: custom vocabulary that improves transcription
+ * accuracy. `term` is the boost phrase injected into the provider's keyterm
+ * prompting; `definition` is human/agent documentation only. `priority` ranks a
+ * term for injection (prioritized terms outrank unprioritized; lower number
+ * first) and decides which terms win when the org exceeds the provider's 100-term
+ * per-request cap.
+ */
+export interface GlossaryTerm {
+  id: string
+  org_id: string
+  term: string
+  definition?: string
+  priority?: number
+  created_at: string
+  created_by: UserRef
+  updated_at: string
+  updated_by: UserRef
+}
+
+export interface CreateGlossaryTermRequest {
+  term: string
+  definition?: string
+  priority?: number
+}
+
+export interface UpdateGlossaryTermRequest {
+  term?: string
+  definition?: string
+  priority?: number
+  /** Removes the term's priority (unprioritizes it) regardless of `priority`. */
+  is_priority_cleared?: boolean
+}
+
+export interface ListGlossaryTermsQuery extends PaginationQuery {
+  /** Case-insensitive substring match on the term text. */
+  search?: string
+}
+
 export interface PaginationQuery {
   page?: number
   page_size?: number
@@ -587,4 +652,21 @@ export interface MaterializeTranscriptionRequest {
 
 export interface ListTranscriptionsQuery extends PaginationQuery {
   status?: string
+  /** List a conversation's transcription artifacts. */
+  conversation_id?: string
+  /** Narrow to the provider-side transcript identity. */
+  provider_request_id?: string
+}
+
+/**
+ * Sends a meeting bot (Ava) into a meeting through an active meeting
+ * connection (adhoc-meeting). join_at schedules the bot ahead of time (ISO
+ * instant; a scheduled bot joins reliably on time — omit to join now); title
+ * seeds the meeting conversation's subject.
+ */
+export interface DispatchMeetingBotRequest {
+  connection_id: string
+  meeting_url: string
+  title?: string
+  join_at?: string
 }

package/src/index.ts

@@ -183,9 +183,14 @@ export type {
   ConversationStatus,
   CreateAgentListenerRequest,
   CreateConnectionRequest,
+  CreateGlossaryTermRequest,
+  DispatchMeetingBotRequest,
+  GlossaryTerm,
+  GlossaryTermService,
   InstallConnectionResponse,
   ListAgentListenersQuery,
   ListConnectionsQuery,
+  ListGlossaryTermsQuery,
   ListConversationsQuery,
   ListMessagesQuery,
   ListParticipantsQuery,
@@ -195,6 +200,7 @@ export type {
   ListRoomsQuery,
   Message,
   MessageDirection,
+  MeetingService,
   MessagePreview,
   MessageRecipient,
   MessageService,
@@ -216,6 +222,7 @@ export type {
   UnreadCounts,
   UpdateAgentListenerRequest,
   UpdateConnectionRequest,
+  UpdateGlossaryTermRequest,
   VoiceService,
   VoiceTranscriptionStream,
 } from './conversation/index.js'