@proteos/sdk 0.19.0 → 0.20.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +40 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +106 -8
- package/dist/index.d.ts +106 -8
- package/dist/index.js +40 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/auth/platform-entities.ts +1 -0
- package/src/conversation/index.ts +73 -0
- package/src/conversation/types.ts +88 -6
- package/src/index.ts +7 -0
package/dist/index.d.cts
CHANGED
|
@@ -1838,21 +1838,30 @@ interface VoiceService {
|
|
|
1838
1838
|
* mirror of packages/go/model/conversation (snake_case, Is-prefixed booleans).
|
|
1839
1839
|
*/
|
|
1840
1840
|
|
|
1841
|
-
/**
|
|
1842
|
-
|
|
1841
|
+
/**
|
|
1842
|
+
* Platform medium a conversation lives on (closed enum; platform identity).
|
|
1843
|
+
* Where a provider brand spans both a chat product and a meeting platform the
|
|
1844
|
+
* channel is suffixed -chat / -meeting (teams-chat vs teams-meeting). The
|
|
1845
|
+
* *-meeting channels are the platforms the Ava meeting-bot family serves;
|
|
1846
|
+
* `meeting` stays the generic fallback for unclassified platforms.
|
|
1847
|
+
*/
|
|
1848
|
+
type Channel = 'slack' | 'email' | 'linkedin' | 'sms' | 'teams-chat' | 'telegram' | 'whatsapp' | 'meeting' | 'zoom-meeting' | 'google-meet' | 'teams-meeting' | 'webex-meeting' | 'adhoc' | 'instagram' | 'messenger' | 'x';
|
|
1843
1849
|
/**
|
|
1844
1850
|
* Concrete integration serving a channel (typed union — one value per shipped
|
|
1845
1851
|
* connector; runtime availability is decided by the service's registry).
|
|
1846
1852
|
* The unipile-* family serves the six messaging systems aggregated through
|
|
1847
|
-
* Unipile — one key per messaging system.
|
|
1853
|
+
* Unipile — one key per messaging system. The meeting keys are the Ava
|
|
1854
|
+
* meeting-bot family: adhoc-meeting dispatches by meeting URL; the calendar
|
|
1855
|
+
* keys auto-join through a user's connected calendar.
|
|
1848
1856
|
*/
|
|
1849
|
-
type ConnectorKey = 'slack' | 'gmail' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x';
|
|
1857
|
+
type ConnectorKey = 'slack' | 'gmail' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x' | 'adhoc-meeting' | 'google-calendar-meeting' | 'microsoft-calendar-meeting';
|
|
1850
1858
|
/**
|
|
1851
1859
|
* Who operates the integration mechanics behind a connector: Proteos' own
|
|
1852
|
-
* integration (native)
|
|
1853
|
-
* Computed on connection reads; the UI
|
|
1860
|
+
* integration (native), an account aggregated through Unipile (unipile), or
|
|
1861
|
+
* the Ava meeting-bot family (ava). Computed on connection reads; the UI
|
|
1862
|
+
* groups the connector catalog by it.
|
|
1854
1863
|
*/
|
|
1855
|
-
type ConnectorProvider = 'native' | 'unipile';
|
|
1864
|
+
type ConnectorProvider = 'native' | 'unipile' | 'ava';
|
|
1856
1865
|
type MessageDirection = 'inbound' | 'outbound';
|
|
1857
1866
|
type MessageStatus = 'received' | 'pending' | 'sent' | 'failed';
|
|
1858
1867
|
type ConnectionScope$1 = 'org' | 'user';
|
|
@@ -2115,6 +2124,12 @@ interface AgentListener {
|
|
|
2115
2124
|
agent_key: string;
|
|
2116
2125
|
trigger_type: AgentListenerTriggerType;
|
|
2117
2126
|
trigger_config: AgentListenerTriggerConfig;
|
|
2127
|
+
/**
|
|
2128
|
+
* When set, gates the listener behind a wake word: the trigger stays dormant
|
|
2129
|
+
* until a message containing this phrase starts a session; once a session is
|
|
2130
|
+
* connected the trigger drives it normally. Empty/absent ⇒ no gate.
|
|
2131
|
+
*/
|
|
2132
|
+
wake_phrase?: string;
|
|
2118
2133
|
/** The user the dispatcher acts as when driving the agent. */
|
|
2119
2134
|
acting_user: UserRef$1;
|
|
2120
2135
|
is_enabled: boolean;
|
|
@@ -2181,6 +2196,8 @@ interface CreateAgentListenerRequest {
|
|
|
2181
2196
|
agent_key: string;
|
|
2182
2197
|
trigger_type: AgentListenerTriggerType;
|
|
2183
2198
|
trigger_config?: AgentListenerTriggerConfig;
|
|
2199
|
+
/** Gate the listener behind a wake word; omit or leave empty for no gate. */
|
|
2200
|
+
wake_phrase?: string;
|
|
2184
2201
|
/** A bare user id; the service wraps it into a person UserRef. */
|
|
2185
2202
|
acting_user_id: string;
|
|
2186
2203
|
/** Omit to default to enabled. */
|
|
@@ -2192,10 +2209,47 @@ interface UpdateAgentListenerRequest {
|
|
|
2192
2209
|
agent_key?: string;
|
|
2193
2210
|
trigger_type?: AgentListenerTriggerType;
|
|
2194
2211
|
trigger_config?: AgentListenerTriggerConfig;
|
|
2212
|
+
/** Set to gate the listener; pass "" to clear an existing wake phrase. */
|
|
2213
|
+
wake_phrase?: string;
|
|
2195
2214
|
acting_user_id?: string;
|
|
2196
2215
|
is_enabled?: boolean;
|
|
2197
2216
|
priority?: number;
|
|
2198
2217
|
}
|
|
2218
|
+
/**
|
|
2219
|
+
* A per-org glossary term: custom vocabulary that improves transcription
|
|
2220
|
+
* accuracy. `term` is the boost phrase injected into the provider's keyterm
|
|
2221
|
+
* prompting; `definition` is human/agent documentation only. `priority` ranks a
|
|
2222
|
+
* term for injection (prioritized terms outrank unprioritized; lower number
|
|
2223
|
+
* first) and decides which terms win when the org exceeds the provider's 100-term
|
|
2224
|
+
* per-request cap.
|
|
2225
|
+
*/
|
|
2226
|
+
interface GlossaryTerm {
|
|
2227
|
+
id: string;
|
|
2228
|
+
org_id: string;
|
|
2229
|
+
term: string;
|
|
2230
|
+
definition?: string;
|
|
2231
|
+
priority?: number;
|
|
2232
|
+
created_at: string;
|
|
2233
|
+
created_by: UserRef$1;
|
|
2234
|
+
updated_at: string;
|
|
2235
|
+
updated_by: UserRef$1;
|
|
2236
|
+
}
|
|
2237
|
+
interface CreateGlossaryTermRequest {
|
|
2238
|
+
term: string;
|
|
2239
|
+
definition?: string;
|
|
2240
|
+
priority?: number;
|
|
2241
|
+
}
|
|
2242
|
+
interface UpdateGlossaryTermRequest {
|
|
2243
|
+
term?: string;
|
|
2244
|
+
definition?: string;
|
|
2245
|
+
priority?: number;
|
|
2246
|
+
/** Removes the term's priority (unprioritizes it) regardless of `priority`. */
|
|
2247
|
+
is_priority_cleared?: boolean;
|
|
2248
|
+
}
|
|
2249
|
+
interface ListGlossaryTermsQuery extends PaginationQuery {
|
|
2250
|
+
/** Case-insensitive substring match on the term text. */
|
|
2251
|
+
search?: string;
|
|
2252
|
+
}
|
|
2199
2253
|
interface PaginationQuery {
|
|
2200
2254
|
page?: number;
|
|
2201
2255
|
page_size?: number;
|
|
@@ -2343,6 +2397,22 @@ interface MaterializeTranscriptionRequest {
|
|
|
2343
2397
|
}
|
|
2344
2398
|
interface ListTranscriptionsQuery extends PaginationQuery {
|
|
2345
2399
|
status?: string;
|
|
2400
|
+
/** List a conversation's transcription artifacts. */
|
|
2401
|
+
conversation_id?: string;
|
|
2402
|
+
/** Narrow to the provider-side transcript identity. */
|
|
2403
|
+
provider_request_id?: string;
|
|
2404
|
+
}
|
|
2405
|
+
/**
|
|
2406
|
+
* Sends a meeting bot (Ava) into a meeting through an active meeting
|
|
2407
|
+
* connection (adhoc-meeting). join_at schedules the bot ahead of time (ISO
|
|
2408
|
+
* instant; a scheduled bot joins reliably on time — omit to join now); title
|
|
2409
|
+
* seeds the meeting conversation's subject.
|
|
2410
|
+
*/
|
|
2411
|
+
interface DispatchMeetingBotRequest {
|
|
2412
|
+
connection_id: string;
|
|
2413
|
+
meeting_url: string;
|
|
2414
|
+
title?: string;
|
|
2415
|
+
join_at?: string;
|
|
2346
2416
|
}
|
|
2347
2417
|
|
|
2348
2418
|
/**
|
|
@@ -2360,11 +2430,26 @@ declare class ConversationClient {
|
|
|
2360
2430
|
readonly conversations: ConversationService;
|
|
2361
2431
|
readonly messages: MessageService;
|
|
2362
2432
|
readonly agentListeners: AgentListenerService;
|
|
2433
|
+
/** Per-org glossary: custom vocabulary that boosts transcription accuracy. */
|
|
2434
|
+
readonly glossaryTerms: GlossaryTermService;
|
|
2363
2435
|
readonly transcriptions: TranscriptionService;
|
|
2436
|
+
/** Meeting bots (Ava): dispatch into a meeting URL, remove from a meeting. */
|
|
2437
|
+
readonly meetings: MeetingService;
|
|
2364
2438
|
/** Realtime speech-to-text (dictation) — moved here from agent-service. */
|
|
2365
2439
|
readonly voice: VoiceService;
|
|
2366
2440
|
constructor(client: ProteosClient);
|
|
2367
2441
|
}
|
|
2442
|
+
/** Meeting bots (Ava) — dispatch by meeting URL and removal. */
|
|
2443
|
+
interface MeetingService {
|
|
2444
|
+
/**
|
|
2445
|
+
* Send Ava to a meeting URL. Resolves with the pre-minted meeting
|
|
2446
|
+
* conversation (channel = the platform classified from the URL); transcript
|
|
2447
|
+
* turns then stream in as inbound messages while the meeting runs.
|
|
2448
|
+
*/
|
|
2449
|
+
dispatch(request: DispatchMeetingBotRequest): Promise<Conversation>;
|
|
2450
|
+
/** Make the bot leave the meeting and end the conversation (by conversation id). */
|
|
2451
|
+
remove(conversationId: string): Promise<Conversation>;
|
|
2452
|
+
}
|
|
2368
2453
|
/** Configured integration instances (Slack workspace, Gmail grant, …). */
|
|
2369
2454
|
interface ConnectionService {
|
|
2370
2455
|
list(query?: ListConnectionsQuery): Promise<ListResponse$1<Connection>>;
|
|
@@ -2413,6 +2498,19 @@ interface AgentListenerService {
|
|
|
2413
2498
|
update(id: string, request: UpdateAgentListenerRequest): Promise<AgentListener>;
|
|
2414
2499
|
delete(id: string): Promise<void>;
|
|
2415
2500
|
}
|
|
2501
|
+
/**
|
|
2502
|
+
* Per-org glossary: custom-vocabulary terms that boost transcription accuracy.
|
|
2503
|
+
* A term feeds the transcription provider's keyterm prompting; `priority` ranks
|
|
2504
|
+
* a term (prioritized terms are injected first, then unprioritized), which
|
|
2505
|
+
* decides the top 100 sent when an org stores more than the provider's cap.
|
|
2506
|
+
*/
|
|
2507
|
+
interface GlossaryTermService {
|
|
2508
|
+
list(query?: ListGlossaryTermsQuery): Promise<ListResponse$1<GlossaryTerm>>;
|
|
2509
|
+
get(id: string): Promise<GlossaryTerm>;
|
|
2510
|
+
create(request: CreateGlossaryTermRequest): Promise<GlossaryTerm>;
|
|
2511
|
+
update(id: string, request: UpdateGlossaryTermRequest): Promise<GlossaryTerm>;
|
|
2512
|
+
delete(id: string): Promise<void>;
|
|
2513
|
+
}
|
|
2416
2514
|
/** Batch transcription of stored audio files + materialization. */
|
|
2417
2515
|
interface TranscriptionService {
|
|
2418
2516
|
/**
|
|
@@ -5222,4 +5320,4 @@ declare class WorkflowClient {
|
|
|
5222
5320
|
constructor(client: ProteosClient);
|
|
5223
5321
|
}
|
|
5224
5322
|
|
|
5225
|
-
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type AgentKickoff, type AgentListener, type AgentListenerService, type AgentListenerTriggerType, type AgentMessagePayload, type AgentResourceListOptions, type AgentService, type ApiErrorResponse, type AppendEventRequest, type AssignPermissionRequest, type AssignRoleRequest, type Attachment, Attribute, AuditFields, type AuthListOptions, type BatchTransactionError, BatchTransactionErrorSchema, type BatchTransactionStatus, type BatchUpsertRecordsResponse, BatchUpsertRecordsResponseSchema, type BatchUpsertTransaction, type BatchUpsertTransactionResult, BatchUpsertTransactionResultSchema, BatchUpsertTransactionSchema, type BinaryRef, type Channel, type ClientEventType, type ClientToolSchema, type Connection, type ConnectionCredentials, type ConnectionEndpoint, type ConnectionScope$1 as ConnectionScope, type ConnectionService, type ConnectionStatus$1 as ConnectionStatus, type Connector, ConnectorClient, type ConnectorConnection, type ConnectionScope as ConnectorConnectionScope, type ConnectionStatus as ConnectorConnectionStatus, type ConnectionTokenResponse as ConnectorConnectionTokenResponse, type CredentialKind as ConnectorCredentialKind, type ConnectorKey, type ConnectorMethod, type ConnectorProvider, type ConsumerGroup, type ContentBlock$1 as ContentBlock, type ContentMatch, type ContentResponse, type ContextCompactedPayload, type Conversation, ConversationClient, type ConversationParticipant, type ConversationService, type ConversationStatus, type CreateAgentListenerRequest, type CreateAgentRequest, type CreateConnectionRequest, type CreateConnectorConnectionRequest, type CreateFileMetadata, type CreateLabelRequest, type CreateLinkRequest, type CreateMcpServerRequest, type CreateNodeRequest, type CreateOrganizationRequest, type CreatePromptRequest, type CreateRecordLinkRequest, type CreateRoleRequest, type CreateSessionRequest, type CreateToolRequest, type CreateUserRequest, type CreateWorkflowRequest, type CredentialSpec, type CronTriggerParams, DEFAULT_PORT, DataClient, type DisplayOptions, ERROR_PORT, type EditContentRequest, type EditContentResponse, type EmptyPayload, ErrorCode, type ErrorCodeType, type ErrorPayload, type EventTriggerParams, type EventType, type EventVerb, EventsClient, type ExecutionError, type ExecutionStatus, type ExecutionTriggerContext, type FileBlock, FileRef, type FileService, type FileVersionContent, FunctionsClient, type GetExecutionDetailResponse, type GetGraphOptions, type GetNodeExecutionItemsOptions, type GetNodeExecutionItemsResponse, type GetNodeTypesResponse, type GraphService, type InlineLinkRequest, type InstallConnectionResponse, type InstallConnectorConnectionResponse, type InvokeActionResponse, type InvokeNodeMethodRequest, type InvokeNodeMethodResponse, type Item, type KickoffSource, type KickoffType, KnowledgeClient, type KnowledgeGraph, type KnowledgeGraphLink, type KnowledgeGraphNode, type KnowledgeLabel, KnowledgeLabelSchema, type KnowledgeLink, KnowledgeLinkSchema, type KnowledgeNode, type KnowledgeNodeLabel, KnowledgeNodeLabelSchema, type KnowledgeNodeMetadata, KnowledgeNodeMetadataSchema, KnowledgeNodeSchema, type KnowledgeNodeSearchResult, KnowledgeNodeSearchResultSchema, type KnowledgeRecordLink, KnowledgeRecordLinkSchema, type LabelService, type LinkService, type LinkType, type ListActionsOptions, type ListAgentListenersQuery, type ListAgentsOptions, type ListConnectionsQuery, type ListConnectorConnectionsQuery, type ListConnectorsQuery, type ListConversationsQuery, type ListEventsOptions, type ListExecutionsOptions, type ListLabelsOptions, type ListLinksOptions, type ListMcpServersOptions, type ListMessagesQuery, type ListNodesOptions, ListOptions, type ListOrganizationsOptions, type ListParticipantsQuery, type ListPromptsOptions, type ListRecordLinksOptions, type ListRecordsOptions, type ListResponse$1 as ListResponse, ListResult, type ListRolePermissionsOptions, type ListRolesOptions, type ListRoomsQuery, type ListSessionsOptions, type ListSkillsOptions, type ListToolsOptions, type ListUserRoleAssignmentsOptions, type ListUsersOptions, type ListWorkflowsOptions, type ManualTriggerParams, type MatchMode, type McpBinding, type McpConnectionState, type McpConnectionStatus, type McpServer, type McpServerAuth, type McpServerOAuth, type McpServerService, type McpToolSummary, type MeService, type Message, type ContentBlock as MessageContentBlock, type MessageDirection, type MessageKickoff, type MessagePreview, type MessageRecipient, type MessageService, type MessageStatus, type MessageTriggerParams, type ModelConfig, type ModelRequestEndPayload, type ModelRequestStartPayload, type ModelUsage, type NeighborDirection, type NeighborEdge, type NeighborNode, type NeighborsOptions, type NodeContentMatches, type NodeDescriptor, type NodeExecution, type NodeGroup, type NodeMethodOption, type NodeNeighborhood, NodeNeighborhoodSchema, type NodeOutline, type NodePosition, type NodeProperty, type NodeRetryPolicy, type NodeRuntime, type NodeService, type NodeStatus, type NodeType, type NodeTypeKey, type NodeTypeService, type NodeTypeStatus, type OnErrorPolicy, type Organization, OrganizationSchema, type OrganizationService, type OutcomeKickoff, type OutcomeRubric, type OutlineHeading, type OutlineRequest, type OutlineResponse, PLATFORM_ENTITIES, PLATFORM_ENTITY_SLUGS, PageIterator, type PairedItem, type ParseStatus, type Participant, type ParticipantRef, type ParticipantSource, type Permission, type PlatformEntity, type PlatformEvent, type PortSpec, type Prompt, type PromptService, type PromptVersion, type PropertyOption, type PropertyType, ProteosClient, ProteosError, type PublishEventRequest, type QueryExecuteMeta, type QueryExecuteResponse, type QueryObject, type QueryRow, type QueryService, type QueryValidateMeta, type QueryValidateResponse, type QueryValue, type Reaction, type ReactionCapability, type ReactionOption, type ReactionSetKind, type ReasoningPayload, type RecipientKind, type RecipientRole, type RecordData, type RecordLinkService, type RecordService, type RedriveResult, type ResultBlock, type Role, type RoleEntityPermission, RoleEntityPermissionSchema, RoleSchema, type RoleService, type Room, type RunWorkflowRequest, type SearchContentRequest, type SearchContentResponse, type SearchNodesRequest, type SendMessageRequest, type SendRecipient, type Session, type SessionEvent, type SessionEventEnvelope, type SessionEventsOptions, type SessionIdlePayload, type SessionService, type SessionStatus, type SessionStreamOptions, type SessionUpdatedPayload, type Skill, type SkillBundle, type SkillService, type SkillVersion, type StartMcpOAuthResponse, type StopReason, StorageClient, type StorageFile, type StorageFileVersion, type TailOptions, type TestNodeCandidate, type TestNodeInputSource, type TestNodeRequest, type TestNodeResponse, type TextBlock, type Tool, type ToolBinding, type ToolConfirmationPayload, type ToolKind, type ToolResultPayload, type ToolService, type ToolUsePayload, type Topic, type TopicKind, type TopicService, type TranscribeStreamOptions, type TranscriptResult, type TriggerKind, type Turn, type UnreadCounts, type UpdateAgentListenerRequest, type UpdateAgentRequest, type UpdateConnectionRequest, type UpdateConnectorConnectionRequest, type UpdateLabelRequest, type UpdateLinkRequest, type UpdateMcpServerRequest, type UpdateNodeRequest, type UpdateOrganizationRequest, type UpdatePromptRequest, type UpdateRoleRequest, type UpdateToolRequest, type UpdateUserRequest, type UpdateWorkflowRequest, type User, type UserMessagePayload, UserRef$2 as UserRef, type UserRoleAssignment, UserRoleAssignmentSchema, UserSchema, type UserService, type VoiceService, type VoiceTranscriptionStream, type WebhookTriggerParams, type Workflow, WorkflowClient, type WorkflowConnection, type WorkflowContentBlock, type WorkflowExecution, type WorkflowGraph, type WorkflowNode, type WorkflowNodeType, type WorkflowStatus, type WorkflowVersion, type WorkflowVersionAuthor, type WorkflowVersionSummary, type WriteContentResponse, type WriteCredentialsRequest, buildUrl, getDefaultErrorCode, isBadRequest, isConflict, isForbidden, isNotFound, isPlatformEntity, isProteosError, isUnauthorized, parseErrorResponse, toQueryParams, toQueryString };
|
|
5323
|
+
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type AgentKickoff, type AgentListener, type AgentListenerService, type AgentListenerTriggerType, type AgentMessagePayload, type AgentResourceListOptions, type AgentService, type ApiErrorResponse, type AppendEventRequest, type AssignPermissionRequest, type AssignRoleRequest, type Attachment, Attribute, AuditFields, type AuthListOptions, type BatchTransactionError, BatchTransactionErrorSchema, type BatchTransactionStatus, type BatchUpsertRecordsResponse, BatchUpsertRecordsResponseSchema, type BatchUpsertTransaction, type BatchUpsertTransactionResult, BatchUpsertTransactionResultSchema, BatchUpsertTransactionSchema, type BinaryRef, type Channel, type ClientEventType, type ClientToolSchema, type Connection, type ConnectionCredentials, type ConnectionEndpoint, type ConnectionScope$1 as ConnectionScope, type ConnectionService, type ConnectionStatus$1 as ConnectionStatus, type Connector, ConnectorClient, type ConnectorConnection, type ConnectionScope as ConnectorConnectionScope, type ConnectionStatus as ConnectorConnectionStatus, type ConnectionTokenResponse as ConnectorConnectionTokenResponse, type CredentialKind as ConnectorCredentialKind, type ConnectorKey, type ConnectorMethod, type ConnectorProvider, type ConsumerGroup, type ContentBlock$1 as ContentBlock, type ContentMatch, type ContentResponse, type ContextCompactedPayload, type Conversation, ConversationClient, type ConversationParticipant, type ConversationService, type ConversationStatus, type CreateAgentListenerRequest, type CreateAgentRequest, type CreateConnectionRequest, type CreateConnectorConnectionRequest, type CreateFileMetadata, type CreateGlossaryTermRequest, type CreateLabelRequest, type CreateLinkRequest, type CreateMcpServerRequest, type CreateNodeRequest, type CreateOrganizationRequest, type CreatePromptRequest, type CreateRecordLinkRequest, type CreateRoleRequest, type CreateSessionRequest, type CreateToolRequest, type CreateUserRequest, type CreateWorkflowRequest, type CredentialSpec, type CronTriggerParams, DEFAULT_PORT, DataClient, type DispatchMeetingBotRequest, type DisplayOptions, ERROR_PORT, type EditContentRequest, type EditContentResponse, type EmptyPayload, ErrorCode, type ErrorCodeType, type ErrorPayload, type EventTriggerParams, type EventType, type EventVerb, EventsClient, type ExecutionError, type ExecutionStatus, type ExecutionTriggerContext, type FileBlock, FileRef, type FileService, type FileVersionContent, FunctionsClient, type GetExecutionDetailResponse, type GetGraphOptions, type GetNodeExecutionItemsOptions, type GetNodeExecutionItemsResponse, type GetNodeTypesResponse, type GlossaryTerm, type GlossaryTermService, type GraphService, type InlineLinkRequest, type InstallConnectionResponse, type InstallConnectorConnectionResponse, type InvokeActionResponse, type InvokeNodeMethodRequest, type InvokeNodeMethodResponse, type Item, type KickoffSource, type KickoffType, KnowledgeClient, type KnowledgeGraph, type KnowledgeGraphLink, type KnowledgeGraphNode, type KnowledgeLabel, KnowledgeLabelSchema, type KnowledgeLink, KnowledgeLinkSchema, type KnowledgeNode, type KnowledgeNodeLabel, KnowledgeNodeLabelSchema, type KnowledgeNodeMetadata, KnowledgeNodeMetadataSchema, KnowledgeNodeSchema, type KnowledgeNodeSearchResult, KnowledgeNodeSearchResultSchema, type KnowledgeRecordLink, KnowledgeRecordLinkSchema, type LabelService, type LinkService, type LinkType, type ListActionsOptions, type ListAgentListenersQuery, type ListAgentsOptions, type ListConnectionsQuery, type ListConnectorConnectionsQuery, type ListConnectorsQuery, type ListConversationsQuery, type ListEventsOptions, type ListExecutionsOptions, type ListGlossaryTermsQuery, type ListLabelsOptions, type ListLinksOptions, type ListMcpServersOptions, type ListMessagesQuery, type ListNodesOptions, ListOptions, type ListOrganizationsOptions, type ListParticipantsQuery, type ListPromptsOptions, type ListRecordLinksOptions, type ListRecordsOptions, type ListResponse$1 as ListResponse, ListResult, type ListRolePermissionsOptions, type ListRolesOptions, type ListRoomsQuery, type ListSessionsOptions, type ListSkillsOptions, type ListToolsOptions, type ListUserRoleAssignmentsOptions, type ListUsersOptions, type ListWorkflowsOptions, type ManualTriggerParams, type MatchMode, type McpBinding, type McpConnectionState, type McpConnectionStatus, type McpServer, type McpServerAuth, type McpServerOAuth, type McpServerService, type McpToolSummary, type MeService, type MeetingService, type Message, type ContentBlock as MessageContentBlock, type MessageDirection, type MessageKickoff, type MessagePreview, type MessageRecipient, type MessageService, type MessageStatus, type MessageTriggerParams, type ModelConfig, type ModelRequestEndPayload, type ModelRequestStartPayload, type ModelUsage, type NeighborDirection, type NeighborEdge, type NeighborNode, type NeighborsOptions, type NodeContentMatches, type NodeDescriptor, type NodeExecution, type NodeGroup, type NodeMethodOption, type NodeNeighborhood, NodeNeighborhoodSchema, type NodeOutline, type NodePosition, type NodeProperty, type NodeRetryPolicy, type NodeRuntime, type NodeService, type NodeStatus, type NodeType, type NodeTypeKey, type NodeTypeService, type NodeTypeStatus, type OnErrorPolicy, type Organization, OrganizationSchema, type OrganizationService, type OutcomeKickoff, type OutcomeRubric, type OutlineHeading, type OutlineRequest, type OutlineResponse, PLATFORM_ENTITIES, PLATFORM_ENTITY_SLUGS, PageIterator, type PairedItem, type ParseStatus, type Participant, type ParticipantRef, type ParticipantSource, type Permission, type PlatformEntity, type PlatformEvent, type PortSpec, type Prompt, type PromptService, type PromptVersion, type PropertyOption, type PropertyType, ProteosClient, ProteosError, type PublishEventRequest, type QueryExecuteMeta, type QueryExecuteResponse, type QueryObject, type QueryRow, type QueryService, type QueryValidateMeta, type QueryValidateResponse, type QueryValue, type Reaction, type ReactionCapability, type ReactionOption, type ReactionSetKind, type ReasoningPayload, type RecipientKind, type RecipientRole, type RecordData, type RecordLinkService, type RecordService, type RedriveResult, type ResultBlock, type Role, type RoleEntityPermission, RoleEntityPermissionSchema, RoleSchema, type RoleService, type Room, type RunWorkflowRequest, type SearchContentRequest, type SearchContentResponse, type SearchNodesRequest, type SendMessageRequest, type SendRecipient, type Session, type SessionEvent, type SessionEventEnvelope, type SessionEventsOptions, type SessionIdlePayload, type SessionService, type SessionStatus, type SessionStreamOptions, type SessionUpdatedPayload, type Skill, type SkillBundle, type SkillService, type SkillVersion, type StartMcpOAuthResponse, type StopReason, StorageClient, type StorageFile, type StorageFileVersion, type TailOptions, type TestNodeCandidate, type TestNodeInputSource, type TestNodeRequest, type TestNodeResponse, type TextBlock, type Tool, type ToolBinding, type ToolConfirmationPayload, type ToolKind, type ToolResultPayload, type ToolService, type ToolUsePayload, type Topic, type TopicKind, type TopicService, type TranscribeStreamOptions, type TranscriptResult, type TriggerKind, type Turn, type UnreadCounts, type UpdateAgentListenerRequest, type UpdateAgentRequest, type UpdateConnectionRequest, type UpdateConnectorConnectionRequest, type UpdateGlossaryTermRequest, type UpdateLabelRequest, type UpdateLinkRequest, type UpdateMcpServerRequest, type UpdateNodeRequest, type UpdateOrganizationRequest, type UpdatePromptRequest, type UpdateRoleRequest, type UpdateToolRequest, type UpdateUserRequest, type UpdateWorkflowRequest, type User, type UserMessagePayload, UserRef$2 as UserRef, type UserRoleAssignment, UserRoleAssignmentSchema, UserSchema, type UserService, type VoiceService, type VoiceTranscriptionStream, type WebhookTriggerParams, type Workflow, WorkflowClient, type WorkflowConnection, type WorkflowContentBlock, type WorkflowExecution, type WorkflowGraph, type WorkflowNode, type WorkflowNodeType, type WorkflowStatus, type WorkflowVersion, type WorkflowVersionAuthor, type WorkflowVersionSummary, type WriteContentResponse, type WriteCredentialsRequest, buildUrl, getDefaultErrorCode, isBadRequest, isConflict, isForbidden, isNotFound, isPlatformEntity, isProteosError, isUnauthorized, parseErrorResponse, toQueryParams, toQueryString };
|
package/dist/index.d.ts
CHANGED
|
@@ -1838,21 +1838,30 @@ interface VoiceService {
|
|
|
1838
1838
|
* mirror of packages/go/model/conversation (snake_case, Is-prefixed booleans).
|
|
1839
1839
|
*/
|
|
1840
1840
|
|
|
1841
|
-
/**
|
|
1842
|
-
|
|
1841
|
+
/**
|
|
1842
|
+
* Platform medium a conversation lives on (closed enum; platform identity).
|
|
1843
|
+
* Where a provider brand spans both a chat product and a meeting platform the
|
|
1844
|
+
* channel is suffixed -chat / -meeting (teams-chat vs teams-meeting). The
|
|
1845
|
+
* *-meeting channels are the platforms the Ava meeting-bot family serves;
|
|
1846
|
+
* `meeting` stays the generic fallback for unclassified platforms.
|
|
1847
|
+
*/
|
|
1848
|
+
type Channel = 'slack' | 'email' | 'linkedin' | 'sms' | 'teams-chat' | 'telegram' | 'whatsapp' | 'meeting' | 'zoom-meeting' | 'google-meet' | 'teams-meeting' | 'webex-meeting' | 'adhoc' | 'instagram' | 'messenger' | 'x';
|
|
1843
1849
|
/**
|
|
1844
1850
|
* Concrete integration serving a channel (typed union — one value per shipped
|
|
1845
1851
|
* connector; runtime availability is decided by the service's registry).
|
|
1846
1852
|
* The unipile-* family serves the six messaging systems aggregated through
|
|
1847
|
-
* Unipile — one key per messaging system.
|
|
1853
|
+
* Unipile — one key per messaging system. The meeting keys are the Ava
|
|
1854
|
+
* meeting-bot family: adhoc-meeting dispatches by meeting URL; the calendar
|
|
1855
|
+
* keys auto-join through a user's connected calendar.
|
|
1848
1856
|
*/
|
|
1849
|
-
type ConnectorKey = 'slack' | 'gmail' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x';
|
|
1857
|
+
type ConnectorKey = 'slack' | 'gmail' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x' | 'adhoc-meeting' | 'google-calendar-meeting' | 'microsoft-calendar-meeting';
|
|
1850
1858
|
/**
|
|
1851
1859
|
* Who operates the integration mechanics behind a connector: Proteos' own
|
|
1852
|
-
* integration (native)
|
|
1853
|
-
* Computed on connection reads; the UI
|
|
1860
|
+
* integration (native), an account aggregated through Unipile (unipile), or
|
|
1861
|
+
* the Ava meeting-bot family (ava). Computed on connection reads; the UI
|
|
1862
|
+
* groups the connector catalog by it.
|
|
1854
1863
|
*/
|
|
1855
|
-
type ConnectorProvider = 'native' | 'unipile';
|
|
1864
|
+
type ConnectorProvider = 'native' | 'unipile' | 'ava';
|
|
1856
1865
|
type MessageDirection = 'inbound' | 'outbound';
|
|
1857
1866
|
type MessageStatus = 'received' | 'pending' | 'sent' | 'failed';
|
|
1858
1867
|
type ConnectionScope$1 = 'org' | 'user';
|
|
@@ -2115,6 +2124,12 @@ interface AgentListener {
|
|
|
2115
2124
|
agent_key: string;
|
|
2116
2125
|
trigger_type: AgentListenerTriggerType;
|
|
2117
2126
|
trigger_config: AgentListenerTriggerConfig;
|
|
2127
|
+
/**
|
|
2128
|
+
* When set, gates the listener behind a wake word: the trigger stays dormant
|
|
2129
|
+
* until a message containing this phrase starts a session; once a session is
|
|
2130
|
+
* connected the trigger drives it normally. Empty/absent ⇒ no gate.
|
|
2131
|
+
*/
|
|
2132
|
+
wake_phrase?: string;
|
|
2118
2133
|
/** The user the dispatcher acts as when driving the agent. */
|
|
2119
2134
|
acting_user: UserRef$1;
|
|
2120
2135
|
is_enabled: boolean;
|
|
@@ -2181,6 +2196,8 @@ interface CreateAgentListenerRequest {
|
|
|
2181
2196
|
agent_key: string;
|
|
2182
2197
|
trigger_type: AgentListenerTriggerType;
|
|
2183
2198
|
trigger_config?: AgentListenerTriggerConfig;
|
|
2199
|
+
/** Gate the listener behind a wake word; omit or leave empty for no gate. */
|
|
2200
|
+
wake_phrase?: string;
|
|
2184
2201
|
/** A bare user id; the service wraps it into a person UserRef. */
|
|
2185
2202
|
acting_user_id: string;
|
|
2186
2203
|
/** Omit to default to enabled. */
|
|
@@ -2192,10 +2209,47 @@ interface UpdateAgentListenerRequest {
|
|
|
2192
2209
|
agent_key?: string;
|
|
2193
2210
|
trigger_type?: AgentListenerTriggerType;
|
|
2194
2211
|
trigger_config?: AgentListenerTriggerConfig;
|
|
2212
|
+
/** Set to gate the listener; pass "" to clear an existing wake phrase. */
|
|
2213
|
+
wake_phrase?: string;
|
|
2195
2214
|
acting_user_id?: string;
|
|
2196
2215
|
is_enabled?: boolean;
|
|
2197
2216
|
priority?: number;
|
|
2198
2217
|
}
|
|
2218
|
+
/**
|
|
2219
|
+
* A per-org glossary term: custom vocabulary that improves transcription
|
|
2220
|
+
* accuracy. `term` is the boost phrase injected into the provider's keyterm
|
|
2221
|
+
* prompting; `definition` is human/agent documentation only. `priority` ranks a
|
|
2222
|
+
* term for injection (prioritized terms outrank unprioritized; lower number
|
|
2223
|
+
* first) and decides which terms win when the org exceeds the provider's 100-term
|
|
2224
|
+
* per-request cap.
|
|
2225
|
+
*/
|
|
2226
|
+
interface GlossaryTerm {
|
|
2227
|
+
id: string;
|
|
2228
|
+
org_id: string;
|
|
2229
|
+
term: string;
|
|
2230
|
+
definition?: string;
|
|
2231
|
+
priority?: number;
|
|
2232
|
+
created_at: string;
|
|
2233
|
+
created_by: UserRef$1;
|
|
2234
|
+
updated_at: string;
|
|
2235
|
+
updated_by: UserRef$1;
|
|
2236
|
+
}
|
|
2237
|
+
interface CreateGlossaryTermRequest {
|
|
2238
|
+
term: string;
|
|
2239
|
+
definition?: string;
|
|
2240
|
+
priority?: number;
|
|
2241
|
+
}
|
|
2242
|
+
interface UpdateGlossaryTermRequest {
|
|
2243
|
+
term?: string;
|
|
2244
|
+
definition?: string;
|
|
2245
|
+
priority?: number;
|
|
2246
|
+
/** Removes the term's priority (unprioritizes it) regardless of `priority`. */
|
|
2247
|
+
is_priority_cleared?: boolean;
|
|
2248
|
+
}
|
|
2249
|
+
interface ListGlossaryTermsQuery extends PaginationQuery {
|
|
2250
|
+
/** Case-insensitive substring match on the term text. */
|
|
2251
|
+
search?: string;
|
|
2252
|
+
}
|
|
2199
2253
|
interface PaginationQuery {
|
|
2200
2254
|
page?: number;
|
|
2201
2255
|
page_size?: number;
|
|
@@ -2343,6 +2397,22 @@ interface MaterializeTranscriptionRequest {
|
|
|
2343
2397
|
}
|
|
2344
2398
|
interface ListTranscriptionsQuery extends PaginationQuery {
|
|
2345
2399
|
status?: string;
|
|
2400
|
+
/** List a conversation's transcription artifacts. */
|
|
2401
|
+
conversation_id?: string;
|
|
2402
|
+
/** Narrow to the provider-side transcript identity. */
|
|
2403
|
+
provider_request_id?: string;
|
|
2404
|
+
}
|
|
2405
|
+
/**
|
|
2406
|
+
* Sends a meeting bot (Ava) into a meeting through an active meeting
|
|
2407
|
+
* connection (adhoc-meeting). join_at schedules the bot ahead of time (ISO
|
|
2408
|
+
* instant; a scheduled bot joins reliably on time — omit to join now); title
|
|
2409
|
+
* seeds the meeting conversation's subject.
|
|
2410
|
+
*/
|
|
2411
|
+
interface DispatchMeetingBotRequest {
|
|
2412
|
+
connection_id: string;
|
|
2413
|
+
meeting_url: string;
|
|
2414
|
+
title?: string;
|
|
2415
|
+
join_at?: string;
|
|
2346
2416
|
}
|
|
2347
2417
|
|
|
2348
2418
|
/**
|
|
@@ -2360,11 +2430,26 @@ declare class ConversationClient {
|
|
|
2360
2430
|
readonly conversations: ConversationService;
|
|
2361
2431
|
readonly messages: MessageService;
|
|
2362
2432
|
readonly agentListeners: AgentListenerService;
|
|
2433
|
+
/** Per-org glossary: custom vocabulary that boosts transcription accuracy. */
|
|
2434
|
+
readonly glossaryTerms: GlossaryTermService;
|
|
2363
2435
|
readonly transcriptions: TranscriptionService;
|
|
2436
|
+
/** Meeting bots (Ava): dispatch into a meeting URL, remove from a meeting. */
|
|
2437
|
+
readonly meetings: MeetingService;
|
|
2364
2438
|
/** Realtime speech-to-text (dictation) — moved here from agent-service. */
|
|
2365
2439
|
readonly voice: VoiceService;
|
|
2366
2440
|
constructor(client: ProteosClient);
|
|
2367
2441
|
}
|
|
2442
|
+
/** Meeting bots (Ava) — dispatch by meeting URL and removal. */
|
|
2443
|
+
interface MeetingService {
|
|
2444
|
+
/**
|
|
2445
|
+
* Send Ava to a meeting URL. Resolves with the pre-minted meeting
|
|
2446
|
+
* conversation (channel = the platform classified from the URL); transcript
|
|
2447
|
+
* turns then stream in as inbound messages while the meeting runs.
|
|
2448
|
+
*/
|
|
2449
|
+
dispatch(request: DispatchMeetingBotRequest): Promise<Conversation>;
|
|
2450
|
+
/** Make the bot leave the meeting and end the conversation (by conversation id). */
|
|
2451
|
+
remove(conversationId: string): Promise<Conversation>;
|
|
2452
|
+
}
|
|
2368
2453
|
/** Configured integration instances (Slack workspace, Gmail grant, …). */
|
|
2369
2454
|
interface ConnectionService {
|
|
2370
2455
|
list(query?: ListConnectionsQuery): Promise<ListResponse$1<Connection>>;
|
|
@@ -2413,6 +2498,19 @@ interface AgentListenerService {
|
|
|
2413
2498
|
update(id: string, request: UpdateAgentListenerRequest): Promise<AgentListener>;
|
|
2414
2499
|
delete(id: string): Promise<void>;
|
|
2415
2500
|
}
|
|
2501
|
+
/**
|
|
2502
|
+
* Per-org glossary: custom-vocabulary terms that boost transcription accuracy.
|
|
2503
|
+
* A term feeds the transcription provider's keyterm prompting; `priority` ranks
|
|
2504
|
+
* a term (prioritized terms are injected first, then unprioritized), which
|
|
2505
|
+
* decides the top 100 sent when an org stores more than the provider's cap.
|
|
2506
|
+
*/
|
|
2507
|
+
interface GlossaryTermService {
|
|
2508
|
+
list(query?: ListGlossaryTermsQuery): Promise<ListResponse$1<GlossaryTerm>>;
|
|
2509
|
+
get(id: string): Promise<GlossaryTerm>;
|
|
2510
|
+
create(request: CreateGlossaryTermRequest): Promise<GlossaryTerm>;
|
|
2511
|
+
update(id: string, request: UpdateGlossaryTermRequest): Promise<GlossaryTerm>;
|
|
2512
|
+
delete(id: string): Promise<void>;
|
|
2513
|
+
}
|
|
2416
2514
|
/** Batch transcription of stored audio files + materialization. */
|
|
2417
2515
|
interface TranscriptionService {
|
|
2418
2516
|
/**
|
|
@@ -5222,4 +5320,4 @@ declare class WorkflowClient {
|
|
|
5222
5320
|
constructor(client: ProteosClient);
|
|
5223
5321
|
}
|
|
5224
5322
|
|
|
5225
|
-
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type AgentKickoff, type AgentListener, type AgentListenerService, type AgentListenerTriggerType, type AgentMessagePayload, type AgentResourceListOptions, type AgentService, type ApiErrorResponse, type AppendEventRequest, type AssignPermissionRequest, type AssignRoleRequest, type Attachment, Attribute, AuditFields, type AuthListOptions, type BatchTransactionError, BatchTransactionErrorSchema, type BatchTransactionStatus, type BatchUpsertRecordsResponse, BatchUpsertRecordsResponseSchema, type BatchUpsertTransaction, type BatchUpsertTransactionResult, BatchUpsertTransactionResultSchema, BatchUpsertTransactionSchema, type BinaryRef, type Channel, type ClientEventType, type ClientToolSchema, type Connection, type ConnectionCredentials, type ConnectionEndpoint, type ConnectionScope$1 as ConnectionScope, type ConnectionService, type ConnectionStatus$1 as ConnectionStatus, type Connector, ConnectorClient, type ConnectorConnection, type ConnectionScope as ConnectorConnectionScope, type ConnectionStatus as ConnectorConnectionStatus, type ConnectionTokenResponse as ConnectorConnectionTokenResponse, type CredentialKind as ConnectorCredentialKind, type ConnectorKey, type ConnectorMethod, type ConnectorProvider, type ConsumerGroup, type ContentBlock$1 as ContentBlock, type ContentMatch, type ContentResponse, type ContextCompactedPayload, type Conversation, ConversationClient, type ConversationParticipant, type ConversationService, type ConversationStatus, type CreateAgentListenerRequest, type CreateAgentRequest, type CreateConnectionRequest, type CreateConnectorConnectionRequest, type CreateFileMetadata, type CreateLabelRequest, type CreateLinkRequest, type CreateMcpServerRequest, type CreateNodeRequest, type CreateOrganizationRequest, type CreatePromptRequest, type CreateRecordLinkRequest, type CreateRoleRequest, type CreateSessionRequest, type CreateToolRequest, type CreateUserRequest, type CreateWorkflowRequest, type CredentialSpec, type CronTriggerParams, DEFAULT_PORT, DataClient, type DisplayOptions, ERROR_PORT, type EditContentRequest, type EditContentResponse, type EmptyPayload, ErrorCode, type ErrorCodeType, type ErrorPayload, type EventTriggerParams, type EventType, type EventVerb, EventsClient, type ExecutionError, type ExecutionStatus, type ExecutionTriggerContext, type FileBlock, FileRef, type FileService, type FileVersionContent, FunctionsClient, type GetExecutionDetailResponse, type GetGraphOptions, type GetNodeExecutionItemsOptions, type GetNodeExecutionItemsResponse, type GetNodeTypesResponse, type GraphService, type InlineLinkRequest, type InstallConnectionResponse, type InstallConnectorConnectionResponse, type InvokeActionResponse, type InvokeNodeMethodRequest, type InvokeNodeMethodResponse, type Item, type KickoffSource, type KickoffType, KnowledgeClient, type KnowledgeGraph, type KnowledgeGraphLink, type KnowledgeGraphNode, type KnowledgeLabel, KnowledgeLabelSchema, type KnowledgeLink, KnowledgeLinkSchema, type KnowledgeNode, type KnowledgeNodeLabel, KnowledgeNodeLabelSchema, type KnowledgeNodeMetadata, KnowledgeNodeMetadataSchema, KnowledgeNodeSchema, type KnowledgeNodeSearchResult, KnowledgeNodeSearchResultSchema, type KnowledgeRecordLink, KnowledgeRecordLinkSchema, type LabelService, type LinkService, type LinkType, type ListActionsOptions, type ListAgentListenersQuery, type ListAgentsOptions, type ListConnectionsQuery, type ListConnectorConnectionsQuery, type ListConnectorsQuery, type ListConversationsQuery, type ListEventsOptions, type ListExecutionsOptions, type ListLabelsOptions, type ListLinksOptions, type ListMcpServersOptions, type ListMessagesQuery, type ListNodesOptions, ListOptions, type ListOrganizationsOptions, type ListParticipantsQuery, type ListPromptsOptions, type ListRecordLinksOptions, type ListRecordsOptions, type ListResponse$1 as ListResponse, ListResult, type ListRolePermissionsOptions, type ListRolesOptions, type ListRoomsQuery, type ListSessionsOptions, type ListSkillsOptions, type ListToolsOptions, type ListUserRoleAssignmentsOptions, type ListUsersOptions, type ListWorkflowsOptions, type ManualTriggerParams, type MatchMode, type McpBinding, type McpConnectionState, type McpConnectionStatus, type McpServer, type McpServerAuth, type McpServerOAuth, type McpServerService, type McpToolSummary, type MeService, type Message, type ContentBlock as MessageContentBlock, type MessageDirection, type MessageKickoff, type MessagePreview, type MessageRecipient, type MessageService, type MessageStatus, type MessageTriggerParams, type ModelConfig, type ModelRequestEndPayload, type ModelRequestStartPayload, type ModelUsage, type NeighborDirection, type NeighborEdge, type NeighborNode, type NeighborsOptions, type NodeContentMatches, type NodeDescriptor, type NodeExecution, type NodeGroup, type NodeMethodOption, type NodeNeighborhood, NodeNeighborhoodSchema, type NodeOutline, type NodePosition, type NodeProperty, type NodeRetryPolicy, type NodeRuntime, type NodeService, type NodeStatus, type NodeType, type NodeTypeKey, type NodeTypeService, type NodeTypeStatus, type OnErrorPolicy, type Organization, OrganizationSchema, type OrganizationService, type OutcomeKickoff, type OutcomeRubric, type OutlineHeading, type OutlineRequest, type OutlineResponse, PLATFORM_ENTITIES, PLATFORM_ENTITY_SLUGS, PageIterator, type PairedItem, type ParseStatus, type Participant, type ParticipantRef, type ParticipantSource, type Permission, type PlatformEntity, type PlatformEvent, type PortSpec, type Prompt, type PromptService, type PromptVersion, type PropertyOption, type PropertyType, ProteosClient, ProteosError, type PublishEventRequest, type QueryExecuteMeta, type QueryExecuteResponse, type QueryObject, type QueryRow, type QueryService, type QueryValidateMeta, type QueryValidateResponse, type QueryValue, type Reaction, type ReactionCapability, type ReactionOption, type ReactionSetKind, type ReasoningPayload, type RecipientKind, type RecipientRole, type RecordData, type RecordLinkService, type RecordService, type RedriveResult, type ResultBlock, type Role, type RoleEntityPermission, RoleEntityPermissionSchema, RoleSchema, type RoleService, type Room, type RunWorkflowRequest, type SearchContentRequest, type SearchContentResponse, type SearchNodesRequest, type SendMessageRequest, type SendRecipient, type Session, type SessionEvent, type SessionEventEnvelope, type SessionEventsOptions, type SessionIdlePayload, type SessionService, type SessionStatus, type SessionStreamOptions, type SessionUpdatedPayload, type Skill, type SkillBundle, type SkillService, type SkillVersion, type StartMcpOAuthResponse, type StopReason, StorageClient, type StorageFile, type StorageFileVersion, type TailOptions, type TestNodeCandidate, type TestNodeInputSource, type TestNodeRequest, type TestNodeResponse, type TextBlock, type Tool, type ToolBinding, type ToolConfirmationPayload, type ToolKind, type ToolResultPayload, type ToolService, type ToolUsePayload, type Topic, type TopicKind, type TopicService, type TranscribeStreamOptions, type TranscriptResult, type TriggerKind, type Turn, type UnreadCounts, type UpdateAgentListenerRequest, type UpdateAgentRequest, type UpdateConnectionRequest, type UpdateConnectorConnectionRequest, type UpdateLabelRequest, type UpdateLinkRequest, type UpdateMcpServerRequest, type UpdateNodeRequest, type UpdateOrganizationRequest, type UpdatePromptRequest, type UpdateRoleRequest, type UpdateToolRequest, type UpdateUserRequest, type UpdateWorkflowRequest, type User, type UserMessagePayload, UserRef$2 as UserRef, type UserRoleAssignment, UserRoleAssignmentSchema, UserSchema, type UserService, type VoiceService, type VoiceTranscriptionStream, type WebhookTriggerParams, type Workflow, WorkflowClient, type WorkflowConnection, type WorkflowContentBlock, type WorkflowExecution, type WorkflowGraph, type WorkflowNode, type WorkflowNodeType, type WorkflowStatus, type WorkflowVersion, type WorkflowVersionAuthor, type WorkflowVersionSummary, type WriteContentResponse, type WriteCredentialsRequest, buildUrl, getDefaultErrorCode, isBadRequest, isConflict, isForbidden, isNotFound, isPlatformEntity, isProteosError, isUnauthorized, parseErrorResponse, toQueryParams, toQueryString };
|
|
5323
|
+
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type AgentKickoff, type AgentListener, type AgentListenerService, type AgentListenerTriggerType, type AgentMessagePayload, type AgentResourceListOptions, type AgentService, type ApiErrorResponse, type AppendEventRequest, type AssignPermissionRequest, type AssignRoleRequest, type Attachment, Attribute, AuditFields, type AuthListOptions, type BatchTransactionError, BatchTransactionErrorSchema, type BatchTransactionStatus, type BatchUpsertRecordsResponse, BatchUpsertRecordsResponseSchema, type BatchUpsertTransaction, type BatchUpsertTransactionResult, BatchUpsertTransactionResultSchema, BatchUpsertTransactionSchema, type BinaryRef, type Channel, type ClientEventType, type ClientToolSchema, type Connection, type ConnectionCredentials, type ConnectionEndpoint, type ConnectionScope$1 as ConnectionScope, type ConnectionService, type ConnectionStatus$1 as ConnectionStatus, type Connector, ConnectorClient, type ConnectorConnection, type ConnectionScope as ConnectorConnectionScope, type ConnectionStatus as ConnectorConnectionStatus, type ConnectionTokenResponse as ConnectorConnectionTokenResponse, type CredentialKind as ConnectorCredentialKind, type ConnectorKey, type ConnectorMethod, type ConnectorProvider, type ConsumerGroup, type ContentBlock$1 as ContentBlock, type ContentMatch, type ContentResponse, type ContextCompactedPayload, type Conversation, ConversationClient, type ConversationParticipant, type ConversationService, type ConversationStatus, type CreateAgentListenerRequest, type CreateAgentRequest, type CreateConnectionRequest, type CreateConnectorConnectionRequest, type CreateFileMetadata, type CreateGlossaryTermRequest, type CreateLabelRequest, type CreateLinkRequest, type CreateMcpServerRequest, type CreateNodeRequest, type CreateOrganizationRequest, type CreatePromptRequest, type CreateRecordLinkRequest, type CreateRoleRequest, type CreateSessionRequest, type CreateToolRequest, type CreateUserRequest, type CreateWorkflowRequest, type CredentialSpec, type CronTriggerParams, DEFAULT_PORT, DataClient, type DispatchMeetingBotRequest, type DisplayOptions, ERROR_PORT, type EditContentRequest, type EditContentResponse, type EmptyPayload, ErrorCode, type ErrorCodeType, type ErrorPayload, type EventTriggerParams, type EventType, type EventVerb, EventsClient, type ExecutionError, type ExecutionStatus, type ExecutionTriggerContext, type FileBlock, FileRef, type FileService, type FileVersionContent, FunctionsClient, type GetExecutionDetailResponse, type GetGraphOptions, type GetNodeExecutionItemsOptions, type GetNodeExecutionItemsResponse, type GetNodeTypesResponse, type GlossaryTerm, type GlossaryTermService, type GraphService, type InlineLinkRequest, type InstallConnectionResponse, type InstallConnectorConnectionResponse, type InvokeActionResponse, type InvokeNodeMethodRequest, type InvokeNodeMethodResponse, type Item, type KickoffSource, type KickoffType, KnowledgeClient, type KnowledgeGraph, type KnowledgeGraphLink, type KnowledgeGraphNode, type KnowledgeLabel, KnowledgeLabelSchema, type KnowledgeLink, KnowledgeLinkSchema, type KnowledgeNode, type KnowledgeNodeLabel, KnowledgeNodeLabelSchema, type KnowledgeNodeMetadata, KnowledgeNodeMetadataSchema, KnowledgeNodeSchema, type KnowledgeNodeSearchResult, KnowledgeNodeSearchResultSchema, type KnowledgeRecordLink, KnowledgeRecordLinkSchema, type LabelService, type LinkService, type LinkType, type ListActionsOptions, type ListAgentListenersQuery, type ListAgentsOptions, type ListConnectionsQuery, type ListConnectorConnectionsQuery, type ListConnectorsQuery, type ListConversationsQuery, type ListEventsOptions, type ListExecutionsOptions, type ListGlossaryTermsQuery, type ListLabelsOptions, type ListLinksOptions, type ListMcpServersOptions, type ListMessagesQuery, type ListNodesOptions, ListOptions, type ListOrganizationsOptions, type ListParticipantsQuery, type ListPromptsOptions, type ListRecordLinksOptions, type ListRecordsOptions, type ListResponse$1 as ListResponse, ListResult, type ListRolePermissionsOptions, type ListRolesOptions, type ListRoomsQuery, type ListSessionsOptions, type ListSkillsOptions, type ListToolsOptions, type ListUserRoleAssignmentsOptions, type ListUsersOptions, type ListWorkflowsOptions, type ManualTriggerParams, type MatchMode, type McpBinding, type McpConnectionState, type McpConnectionStatus, type McpServer, type McpServerAuth, type McpServerOAuth, type McpServerService, type McpToolSummary, type MeService, type MeetingService, type Message, type ContentBlock as MessageContentBlock, type MessageDirection, type MessageKickoff, type MessagePreview, type MessageRecipient, type MessageService, type MessageStatus, type MessageTriggerParams, type ModelConfig, type ModelRequestEndPayload, type ModelRequestStartPayload, type ModelUsage, type NeighborDirection, type NeighborEdge, type NeighborNode, type NeighborsOptions, type NodeContentMatches, type NodeDescriptor, type NodeExecution, type NodeGroup, type NodeMethodOption, type NodeNeighborhood, NodeNeighborhoodSchema, type NodeOutline, type NodePosition, type NodeProperty, type NodeRetryPolicy, type NodeRuntime, type NodeService, type NodeStatus, type NodeType, type NodeTypeKey, type NodeTypeService, type NodeTypeStatus, type OnErrorPolicy, type Organization, OrganizationSchema, type OrganizationService, type OutcomeKickoff, type OutcomeRubric, type OutlineHeading, type OutlineRequest, type OutlineResponse, PLATFORM_ENTITIES, PLATFORM_ENTITY_SLUGS, PageIterator, type PairedItem, type ParseStatus, type Participant, type ParticipantRef, type ParticipantSource, type Permission, type PlatformEntity, type PlatformEvent, type PortSpec, type Prompt, type PromptService, type PromptVersion, type PropertyOption, type PropertyType, ProteosClient, ProteosError, type PublishEventRequest, type QueryExecuteMeta, type QueryExecuteResponse, type QueryObject, type QueryRow, type QueryService, type QueryValidateMeta, type QueryValidateResponse, type QueryValue, type Reaction, type ReactionCapability, type ReactionOption, type ReactionSetKind, type ReasoningPayload, type RecipientKind, type RecipientRole, type RecordData, type RecordLinkService, type RecordService, type RedriveResult, type ResultBlock, type Role, type RoleEntityPermission, RoleEntityPermissionSchema, RoleSchema, type RoleService, type Room, type RunWorkflowRequest, type SearchContentRequest, type SearchContentResponse, type SearchNodesRequest, type SendMessageRequest, type SendRecipient, type Session, type SessionEvent, type SessionEventEnvelope, type SessionEventsOptions, type SessionIdlePayload, type SessionService, type SessionStatus, type SessionStreamOptions, type SessionUpdatedPayload, type Skill, type SkillBundle, type SkillService, type SkillVersion, type StartMcpOAuthResponse, type StopReason, StorageClient, type StorageFile, type StorageFileVersion, type TailOptions, type TestNodeCandidate, type TestNodeInputSource, type TestNodeRequest, type TestNodeResponse, type TextBlock, type Tool, type ToolBinding, type ToolConfirmationPayload, type ToolKind, type ToolResultPayload, type ToolService, type ToolUsePayload, type Topic, type TopicKind, type TopicService, type TranscribeStreamOptions, type TranscriptResult, type TriggerKind, type Turn, type UnreadCounts, type UpdateAgentListenerRequest, type UpdateAgentRequest, type UpdateConnectionRequest, type UpdateConnectorConnectionRequest, type UpdateGlossaryTermRequest, type UpdateLabelRequest, type UpdateLinkRequest, type UpdateMcpServerRequest, type UpdateNodeRequest, type UpdateOrganizationRequest, type UpdatePromptRequest, type UpdateRoleRequest, type UpdateToolRequest, type UpdateUserRequest, type UpdateWorkflowRequest, type User, type UserMessagePayload, UserRef$2 as UserRef, type UserRoleAssignment, UserRoleAssignmentSchema, UserSchema, type UserService, type VoiceService, type VoiceTranscriptionStream, type WebhookTriggerParams, type Workflow, WorkflowClient, type WorkflowConnection, type WorkflowContentBlock, type WorkflowExecution, type WorkflowGraph, type WorkflowNode, type WorkflowNodeType, type WorkflowStatus, type WorkflowVersion, type WorkflowVersionAuthor, type WorkflowVersionSummary, type WriteContentResponse, type WriteCredentialsRequest, buildUrl, getDefaultErrorCode, isBadRequest, isConflict, isForbidden, isNotFound, isPlatformEntity, isProteosError, isUnauthorized, parseErrorResponse, toQueryParams, toQueryString };
|
package/dist/index.js
CHANGED
|
@@ -525,6 +525,7 @@ var PLATFORM_ENTITIES = [
|
|
|
525
525
|
{ slug: "messages", name: "Messages" },
|
|
526
526
|
{ slug: "agent-listeners", name: "Agent Listeners" },
|
|
527
527
|
{ slug: "transcriptions", name: "Transcriptions" },
|
|
528
|
+
{ slug: "glossary-terms", name: "Glossary Terms" },
|
|
528
529
|
// Connectors (connector-service). `connections` above is shared; this is the
|
|
529
530
|
// manifest catalog.
|
|
530
531
|
{ slug: "connectors", name: "Connectors" }
|
|
@@ -1138,7 +1139,11 @@ var ConversationClient = class {
|
|
|
1138
1139
|
conversations;
|
|
1139
1140
|
messages;
|
|
1140
1141
|
agentListeners;
|
|
1142
|
+
/** Per-org glossary: custom vocabulary that boosts transcription accuracy. */
|
|
1143
|
+
glossaryTerms;
|
|
1141
1144
|
transcriptions;
|
|
1145
|
+
/** Meeting bots (Ava): dispatch into a meeting URL, remove from a meeting. */
|
|
1146
|
+
meetings;
|
|
1142
1147
|
/** Realtime speech-to-text (dictation) — moved here from agent-service. */
|
|
1143
1148
|
voice;
|
|
1144
1149
|
constructor(client) {
|
|
@@ -1146,10 +1151,24 @@ var ConversationClient = class {
|
|
|
1146
1151
|
this.conversations = new ConversationServiceImpl(client);
|
|
1147
1152
|
this.messages = new MessageServiceImpl(client);
|
|
1148
1153
|
this.agentListeners = new AgentListenerServiceImpl(client);
|
|
1154
|
+
this.glossaryTerms = new GlossaryTermServiceImpl(client);
|
|
1149
1155
|
this.transcriptions = new TranscriptionServiceImpl(client);
|
|
1156
|
+
this.meetings = new MeetingServiceImpl(client);
|
|
1150
1157
|
this.voice = new VoiceServiceImpl(client);
|
|
1151
1158
|
}
|
|
1152
1159
|
};
|
|
1160
|
+
var MeetingServiceImpl = class {
|
|
1161
|
+
constructor(client) {
|
|
1162
|
+
this.client = client;
|
|
1163
|
+
}
|
|
1164
|
+
client;
|
|
1165
|
+
dispatch(request) {
|
|
1166
|
+
return this.client.request("POST", `${CONVERSATION_BASE_PATH}/meetings`, request);
|
|
1167
|
+
}
|
|
1168
|
+
remove(conversationId) {
|
|
1169
|
+
return this.client.request("DELETE", `${CONVERSATION_BASE_PATH}/meetings/${encodeURIComponent(conversationId)}`);
|
|
1170
|
+
}
|
|
1171
|
+
};
|
|
1153
1172
|
var ConnectionServiceImpl = class {
|
|
1154
1173
|
constructor(client) {
|
|
1155
1174
|
this.client = client;
|
|
@@ -1271,6 +1290,27 @@ var AgentListenerServiceImpl = class {
|
|
|
1271
1290
|
await this.client.request("DELETE", `${CONVERSATION_BASE_PATH}/agent-listeners/${encodeURIComponent(id)}`);
|
|
1272
1291
|
}
|
|
1273
1292
|
};
|
|
1293
|
+
var GlossaryTermServiceImpl = class {
|
|
1294
|
+
constructor(client) {
|
|
1295
|
+
this.client = client;
|
|
1296
|
+
}
|
|
1297
|
+
client;
|
|
1298
|
+
list(query = {}) {
|
|
1299
|
+
return this.client.requestWithQuery("GET", `${CONVERSATION_BASE_PATH}/glossary-terms`, query);
|
|
1300
|
+
}
|
|
1301
|
+
get(id) {
|
|
1302
|
+
return this.client.request("GET", `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`);
|
|
1303
|
+
}
|
|
1304
|
+
create(request) {
|
|
1305
|
+
return this.client.request("POST", `${CONVERSATION_BASE_PATH}/glossary-terms`, request);
|
|
1306
|
+
}
|
|
1307
|
+
update(id, request) {
|
|
1308
|
+
return this.client.request("PATCH", `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`, request);
|
|
1309
|
+
}
|
|
1310
|
+
async delete(id) {
|
|
1311
|
+
await this.client.request("DELETE", `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`);
|
|
1312
|
+
}
|
|
1313
|
+
};
|
|
1274
1314
|
var TranscriptionServiceImpl = class {
|
|
1275
1315
|
constructor(client) {
|
|
1276
1316
|
this.client = client;
|