@proteos/sdk 0.32.1 → 0.33.0
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.map +1 -1
- package/dist/index.d.cts +81 -39
- package/dist/index.d.ts +81 -39
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/connector/types.ts +23 -1
- package/src/conversation/index.ts +11 -4
- package/src/conversation/types.ts +20 -0
- package/src/index.ts +1 -5
- package/src/workflow/index.ts +0 -5
- package/src/workflow/types.ts +24 -36
package/dist/index.d.cts
CHANGED
|
@@ -1826,7 +1826,7 @@ type ConnectionStatus$1 = 'pending' | 'active' | 'error' | 'revoked';
|
|
|
1826
1826
|
/** org-wide integration vs a single user's grant. */
|
|
1827
1827
|
type ConnectionScope$1 = 'org' | 'user';
|
|
1828
1828
|
/** How a connector authenticates. */
|
|
1829
|
-
type CredentialKind = 'oauth' | 'api_key' | 'basic' | 'bot_token';
|
|
1829
|
+
type CredentialKind = 'oauth' | 'api_key' | 'basic' | 'bot_token' | 'service_account';
|
|
1830
1830
|
interface UserRef$1 {
|
|
1831
1831
|
type: string;
|
|
1832
1832
|
id: string;
|
|
@@ -1860,6 +1860,16 @@ interface ConnectorOAuthConfig {
|
|
|
1860
1860
|
client_id_variable_key: string;
|
|
1861
1861
|
client_secret_variable_key: string;
|
|
1862
1862
|
}
|
|
1863
|
+
/**
|
|
1864
|
+
* The service-account wiring of a connector supporting the service_account
|
|
1865
|
+
* kind. Like the OAuth app credentials, the SA key is an org VARIABLE —
|
|
1866
|
+
* key_variable_key names the default; a connection may reference its own via
|
|
1867
|
+
* settings.service_account_key_variable.
|
|
1868
|
+
*/
|
|
1869
|
+
interface ConnectorServiceAccountConfig {
|
|
1870
|
+
key_variable_key: string;
|
|
1871
|
+
scopes: string[];
|
|
1872
|
+
}
|
|
1863
1873
|
/** A connector TYPE (google-calendar, a customer's vertex-tax, …). */
|
|
1864
1874
|
interface Connector {
|
|
1865
1875
|
key: string;
|
|
@@ -1868,12 +1878,21 @@ interface Connector {
|
|
|
1868
1878
|
description?: string;
|
|
1869
1879
|
icon?: string;
|
|
1870
1880
|
credential_kind: CredentialKind;
|
|
1881
|
+
/** Every kind a connection may use; absent/empty = exactly [credential_kind]. */
|
|
1882
|
+
supported_credential_kinds?: CredentialKind[];
|
|
1871
1883
|
oauth?: ConnectorOAuthConfig;
|
|
1884
|
+
service_account?: ConnectorServiceAccountConfig;
|
|
1872
1885
|
/**
|
|
1873
1886
|
* COMPUTED: the broker's per-environment OAuth callback — register it as an
|
|
1874
1887
|
* authorized redirect URI on the provider app.
|
|
1875
1888
|
*/
|
|
1876
1889
|
oauth_redirect_uri?: string;
|
|
1890
|
+
/**
|
|
1891
|
+
* COMPUTED: the environment ships platform-default OAuth app credentials
|
|
1892
|
+
* for this connector, so the connect wizard can skip collecting them.
|
|
1893
|
+
* Org variables always override the default.
|
|
1894
|
+
*/
|
|
1895
|
+
has_default_app_credentials?: boolean;
|
|
1877
1896
|
config_schema?: Attribute[];
|
|
1878
1897
|
methods: ConnectorMethod[];
|
|
1879
1898
|
origin: 'pre_built' | 'custom';
|
|
@@ -1893,6 +1912,11 @@ interface ConnectorConnection {
|
|
|
1893
1912
|
scope: ConnectionScope$1;
|
|
1894
1913
|
owner?: UserRef$1;
|
|
1895
1914
|
external_account_id: string;
|
|
1915
|
+
/** Redacted {kind, data} credential envelope — secrets are masked; use kind to tell how the connection authenticates. */
|
|
1916
|
+
credentials?: {
|
|
1917
|
+
kind: CredentialKind;
|
|
1918
|
+
data?: Record<string, unknown>;
|
|
1919
|
+
};
|
|
1896
1920
|
settings: Record<string, unknown>;
|
|
1897
1921
|
status: ConnectionStatus$1;
|
|
1898
1922
|
status_detail?: string;
|
|
@@ -2013,7 +2037,7 @@ type Channel = 'slack' | 'email' | 'linkedin' | 'sms' | 'teams-chat' | 'telegram
|
|
|
2013
2037
|
* meeting-bot family: adhoc-meeting dispatches by meeting URL; the calendar
|
|
2014
2038
|
* keys auto-join through a user's connected calendar.
|
|
2015
2039
|
*/
|
|
2016
|
-
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';
|
|
2040
|
+
type ConnectorKey = 'slack' | 'gmail' | 'outlook' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x' | 'adhoc-meeting' | 'google-calendar-meeting' | 'microsoft-calendar-meeting';
|
|
2017
2041
|
/**
|
|
2018
2042
|
* Who operates the integration mechanics behind a connector: Proteos' own
|
|
2019
2043
|
* integration (native), an account aggregated through Unipile (unipile), or
|
|
@@ -2034,6 +2058,15 @@ type ConnectionStatus = 'pending' | 'active' | 'error' | 'revoked';
|
|
|
2034
2058
|
* drafting) — hidden from the default list until the first successful send.
|
|
2035
2059
|
*/
|
|
2036
2060
|
type ConversationStatus = 'active' | 'ended' | 'archived' | 'draft';
|
|
2061
|
+
/**
|
|
2062
|
+
* Generation lifecycle of a conversation's `summary`. `none` is the resting
|
|
2063
|
+
* default — no summary exists and none is being produced, the state of every
|
|
2064
|
+
* conversation that is not a transcript-backed meeting. `processing` is claimed
|
|
2065
|
+
* for the duration of one generation run (automatic at transcript attach, or a
|
|
2066
|
+
* manual `meetings.summarize()`), so any client can render "Summarizing…"
|
|
2067
|
+
* without having started the run itself.
|
|
2068
|
+
*/
|
|
2069
|
+
type ConversationSummaryStatus = 'none' | 'processing' | 'completed' | 'failed';
|
|
2037
2070
|
type AgentListenerTriggerType = 'always' | 'mention' | 'channel' | 'keyword';
|
|
2038
2071
|
interface UserRef {
|
|
2039
2072
|
type: string;
|
|
@@ -2156,6 +2189,16 @@ interface Conversation {
|
|
|
2156
2189
|
* conversations, editable via update(). Absent when no summary exists.
|
|
2157
2190
|
*/
|
|
2158
2191
|
summary?: string;
|
|
2192
|
+
/**
|
|
2193
|
+
* Generation lifecycle of `summary`. Poll `conversations.get(id)` while this
|
|
2194
|
+
* reads `processing` to pick up the finished summary.
|
|
2195
|
+
*/
|
|
2196
|
+
summary_status: ConversationSummaryStatus;
|
|
2197
|
+
/**
|
|
2198
|
+
* When the current `processing` run was claimed; absent otherwise. Bounds the
|
|
2199
|
+
* claim server-side and gives clients an elapsed time to show.
|
|
2200
|
+
*/
|
|
2201
|
+
summary_started_at?: string;
|
|
2159
2202
|
status: ConversationStatus;
|
|
2160
2203
|
/**
|
|
2161
2204
|
* Room directory row a room-borne thread (Slack channel conversation) lives
|
|
@@ -2978,10 +3021,17 @@ interface MeetingService {
|
|
|
2978
3021
|
/** Make the bot leave the meeting and end the conversation (by conversation id). */
|
|
2979
3022
|
remove(conversationId: string): Promise<Conversation>;
|
|
2980
3023
|
/**
|
|
2981
|
-
*
|
|
2982
|
-
* transcript, overwriting any existing one
|
|
2983
|
-
*
|
|
2984
|
-
* conversation
|
|
3024
|
+
* START regenerating this meeting conversation's markdown summary from its
|
|
3025
|
+
* stored transcript, overwriting any existing one when it lands. Generation
|
|
3026
|
+
* runs server-side beyond this request, so the promise resolves as soon as the
|
|
3027
|
+
* conversation is CLAIMED — with `summary_status: 'processing'` and the OLD
|
|
3028
|
+
* `summary` still attached. Poll `conversations.get(id)` until
|
|
3029
|
+
* `summary_status` is `completed` (or `failed`) to read the new one.
|
|
3030
|
+
*
|
|
3031
|
+
* Rejects with `no_transcript` when the conversation has no completed
|
|
3032
|
+
* transcript to summarize, `summarization_unavailable` when the environment
|
|
3033
|
+
* has no generator configured, and `summary_in_progress` when a generation is
|
|
3034
|
+
* already running for this conversation.
|
|
2985
3035
|
*/
|
|
2986
3036
|
summarize(conversationId: string): Promise<Conversation>;
|
|
2987
3037
|
}
|
|
@@ -5281,7 +5331,9 @@ type NodeRuntime = 'go' | 'wasm' | 'intrinsic';
|
|
|
5281
5331
|
/** Coarse catalog grouping of a node type. */
|
|
5282
5332
|
type NodeGroup = 'trigger' | 'action' | 'transform' | 'flow';
|
|
5283
5333
|
/** Control type of one descriptor property (n8n INodeProperties paradigm). */
|
|
5284
|
-
type PropertyType = 'string' | 'number' | 'boolean' | 'options' | 'multi_options' | 'json' | 'date_time' | 'color' | 'notice' | 'hidden' | 'collection' | 'fixed_collection' | 'credentials_select' | 'button'
|
|
5334
|
+
type PropertyType = 'string' | 'number' | 'boolean' | 'options' | 'multi_options' | 'json' | 'date_time' | 'color' | 'notice' | 'hidden' | 'collection' | 'fixed_collection' | 'credentials_select' | 'button'
|
|
5335
|
+
/** Edits a platform attribute list (`Attribute[]`) via the shared attribute schema builder. */
|
|
5336
|
+
| 'attribute_schema' | 'resource_locator' | 'resource_mapper' | 'filter' | 'assignment_collection';
|
|
5285
5337
|
/**
|
|
5286
5338
|
* One named input or output port. Port keys are stable identifiers referenced
|
|
5287
5339
|
* by connections (never indexes).
|
|
@@ -5442,45 +5494,35 @@ interface MessageTriggerParams {
|
|
|
5442
5494
|
}
|
|
5443
5495
|
type KickoffType = 'message' | 'outcome';
|
|
5444
5496
|
/**
|
|
5445
|
-
* Where a kickoff draws its instruction text from: typed inline
|
|
5446
|
-
* resolved from a reusable agent-service Prompt by key
|
|
5497
|
+
* Where a kickoff slot draws its instruction text from: typed inline
|
|
5498
|
+
* (`manual`) or resolved from a reusable agent-service Prompt by key
|
|
5499
|
+
* (`prompt`) at run time.
|
|
5447
5500
|
*/
|
|
5448
5501
|
type KickoffSource = 'manual' | 'prompt';
|
|
5449
|
-
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
|
|
5454
|
-
|
|
5455
|
-
|
|
5456
|
-
|
|
5457
|
-
|
|
5458
|
-
|
|
5459
|
-
|
|
5460
|
-
|
|
5461
|
-
|
|
5462
|
-
type: 'text' | 'file';
|
|
5463
|
-
content?: string;
|
|
5464
|
-
file_id?: string;
|
|
5465
|
-
}
|
|
5466
|
-
interface OutcomeKickoff {
|
|
5467
|
-
/** Description and rubric are independently sourced (manual vs prompt). */
|
|
5502
|
+
/**
|
|
5503
|
+
* Flat, descriptor-driven parameters of the `action.agent` node (gated by
|
|
5504
|
+
* display_options on `kickoff_type` / `*_source`). `output_schema` declares
|
|
5505
|
+
* the node's structured output as platform attributes — the agent records it
|
|
5506
|
+
* via the session-scoped `set_output` tool; `is_output_required` fails the
|
|
5507
|
+
* node when the agent finishes without setting it.
|
|
5508
|
+
*/
|
|
5509
|
+
interface AgentActionParams {
|
|
5510
|
+
agent_key: string;
|
|
5511
|
+
kickoff_type: KickoffType;
|
|
5512
|
+
message_source?: KickoffSource;
|
|
5513
|
+
message_text?: string;
|
|
5514
|
+
message_prompt_key?: string;
|
|
5468
5515
|
description_source?: KickoffSource;
|
|
5469
5516
|
description?: string;
|
|
5470
5517
|
description_prompt_key?: string;
|
|
5471
5518
|
rubric_source?: KickoffSource;
|
|
5472
|
-
|
|
5519
|
+
rubric_type?: 'text' | 'file';
|
|
5520
|
+
rubric_content?: string;
|
|
5521
|
+
rubric_file_id?: string;
|
|
5473
5522
|
rubric_prompt_key?: string;
|
|
5474
5523
|
max_iterations?: number;
|
|
5475
|
-
|
|
5476
|
-
|
|
5477
|
-
type: KickoffType;
|
|
5478
|
-
message?: MessageKickoff;
|
|
5479
|
-
outcome?: OutcomeKickoff;
|
|
5480
|
-
}
|
|
5481
|
-
interface AgentActionParams {
|
|
5482
|
-
agent_key: string;
|
|
5483
|
-
kickoff: AgentKickoff;
|
|
5524
|
+
output_schema?: Attribute[];
|
|
5525
|
+
is_output_required?: boolean;
|
|
5484
5526
|
}
|
|
5485
5527
|
interface Workflow extends AuditFields {
|
|
5486
5528
|
org_id: string;
|
|
@@ -5805,4 +5847,4 @@ declare class WorkflowClient {
|
|
|
5805
5847
|
constructor(client: ProteosClient);
|
|
5806
5848
|
}
|
|
5807
5849
|
|
|
5808
|
-
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type AddressFilterConfig, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type
|
|
5850
|
+
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type AddressFilterConfig, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type AgentListener, type AgentListenerService, type AgentListenerTriggerType, type AgentMessagePayload, type AgentResourceListOptions, type AgentService, type AllFilterConfig, type ApiErrorResponse, type AppendEventRequest, type AssignPermissionRequest, type AssignRoleRequest, type AttachContactAddressRequest, type Attachment, Attribute, AuditFields, type AuthListOptions, type AutomatedFilterConfig, type AutomatedSignal, type BatchTransactionError, BatchTransactionErrorSchema, type BatchTransactionStatus, type BatchUpsertRecordsResponse, BatchUpsertRecordsResponseSchema, type BatchUpsertTransaction, type BatchUpsertTransactionResult, BatchUpsertTransactionResultSchema, BatchUpsertTransactionSchema, type BinaryRef, type BlockContactRequest, type Channel, type ClientEventType, type ClientToolSchema, type Connection, type ConnectionCredentials, type ConnectionEndpoint, type ConnectionScope, type ConnectionService, type ConnectionStatus, type Connector, ConnectorClient, type ConnectorConnection, type ConnectionScope$1 as ConnectorConnectionScope, type ConnectionStatus$1 as ConnectorConnectionStatus, type ConnectionTokenResponse as ConnectorConnectionTokenResponse, type CredentialKind as ConnectorCredentialKind, type ConnectorKey, type ConnectorMethod, type ConnectorProvider, type ConsentStatus, type ConsumerGroup, type Contact, type ContactAddress, type ContactAddressKind, type ContactAddressSource, type ContactErasureRequest, type ContactMergeProposal, type ContactRef, type ContactService, type ContactSource, type ContactStatus, type ContentBlock$1 as ContentBlock, type ContentMatch, type ContentResponse, type ContextCompactedPayload, type Conversation, ConversationClient, type ConversationFilter, type ConversationFilterAction, type ConversationFilterConfig, type ConversationFilterEvent, type ConversationFilterService, type ConversationFilterType, type ConversationParticipant, type ConversationService, type ConversationStatus, type ConversationSummaryStatus, type CreateAgentListenerRequest, type CreateAgentRequest, type CreateConnectionRequest, type CreateConnectorConnectionRequest, type CreateConversationFilterRequest, 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 DependentAgent, type DependentSyncResult, type DispatchMeetingBotRequest, type DisplayOptions, type DomainFilterConfig, ERROR_PORT, type EditContentRequest, type EditContentResponse, type EmptyPayload, type ErasureRequestStatus, 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, type FilterMatchOn, FunctionsClient, type GetExecutionDetailResponse, type GetGraphOptions, type GetNodeExecutionItemsOptions, type GetNodeExecutionItemsResponse, type GetNodeTypesResponse, type GlossaryTerm, type GlossaryTermService, type GraphService, type InlineLinkRequest, type InstallConnectionResponse, type InstallConnectorConnectionResponse, type InternalConversationsFilterConfig, 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 ListContactAddressesQuery, type ListContactMergeProposalsQuery, type ListContactsQuery, type ListConversationFilterEventsQuery, type ListConversationFiltersQuery, type ListConversationsQuery, type ListEventsOptions, type ListExecutionsOptions, type ListGlossaryTermsQuery, type ListLabelsOptions, type ListLinksOptions, type ListMcpServersOptions, type ListMessagesQuery, type ListNodesOptions, ListOptions, type ListOrganizationsOptions, type ListPromptsOptions, type ListRecordLinksOptions, type ListRecordsOptions, type 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 MergeContactsRequest, type MergeProposalStatus, type Message, type ContentBlock as MessageContentBlock, type MessageDirection, 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 OutlineHeading, type OutlineRequest, type OutlineResponse, PLATFORM_ENTITIES, PLATFORM_ENTITY_SLUGS, PageIterator, type PairedItem, type ParseStatus, type Permission, type PermissionEventSource, type PermissionEventType, type PlatformEntity, type PlatformEvent, type PortSpec, type Prompt, type PromptService, type PromptVersion, type PropertyOption, type PropertyType, ProteosClient, ProteosError, PublicAccessOperation, 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 RecordPermissionEventRequest, type RecordService, type RedriveResult, type ResultBlock, type Role, type RoleBasedFilterConfig, 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 UpdateContactRequest, type UpdateConversationFilterRequest, type UpdateDraftRequest, type UpdateFileMetadata, 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 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
|
@@ -1826,7 +1826,7 @@ type ConnectionStatus$1 = 'pending' | 'active' | 'error' | 'revoked';
|
|
|
1826
1826
|
/** org-wide integration vs a single user's grant. */
|
|
1827
1827
|
type ConnectionScope$1 = 'org' | 'user';
|
|
1828
1828
|
/** How a connector authenticates. */
|
|
1829
|
-
type CredentialKind = 'oauth' | 'api_key' | 'basic' | 'bot_token';
|
|
1829
|
+
type CredentialKind = 'oauth' | 'api_key' | 'basic' | 'bot_token' | 'service_account';
|
|
1830
1830
|
interface UserRef$1 {
|
|
1831
1831
|
type: string;
|
|
1832
1832
|
id: string;
|
|
@@ -1860,6 +1860,16 @@ interface ConnectorOAuthConfig {
|
|
|
1860
1860
|
client_id_variable_key: string;
|
|
1861
1861
|
client_secret_variable_key: string;
|
|
1862
1862
|
}
|
|
1863
|
+
/**
|
|
1864
|
+
* The service-account wiring of a connector supporting the service_account
|
|
1865
|
+
* kind. Like the OAuth app credentials, the SA key is an org VARIABLE —
|
|
1866
|
+
* key_variable_key names the default; a connection may reference its own via
|
|
1867
|
+
* settings.service_account_key_variable.
|
|
1868
|
+
*/
|
|
1869
|
+
interface ConnectorServiceAccountConfig {
|
|
1870
|
+
key_variable_key: string;
|
|
1871
|
+
scopes: string[];
|
|
1872
|
+
}
|
|
1863
1873
|
/** A connector TYPE (google-calendar, a customer's vertex-tax, …). */
|
|
1864
1874
|
interface Connector {
|
|
1865
1875
|
key: string;
|
|
@@ -1868,12 +1878,21 @@ interface Connector {
|
|
|
1868
1878
|
description?: string;
|
|
1869
1879
|
icon?: string;
|
|
1870
1880
|
credential_kind: CredentialKind;
|
|
1881
|
+
/** Every kind a connection may use; absent/empty = exactly [credential_kind]. */
|
|
1882
|
+
supported_credential_kinds?: CredentialKind[];
|
|
1871
1883
|
oauth?: ConnectorOAuthConfig;
|
|
1884
|
+
service_account?: ConnectorServiceAccountConfig;
|
|
1872
1885
|
/**
|
|
1873
1886
|
* COMPUTED: the broker's per-environment OAuth callback — register it as an
|
|
1874
1887
|
* authorized redirect URI on the provider app.
|
|
1875
1888
|
*/
|
|
1876
1889
|
oauth_redirect_uri?: string;
|
|
1890
|
+
/**
|
|
1891
|
+
* COMPUTED: the environment ships platform-default OAuth app credentials
|
|
1892
|
+
* for this connector, so the connect wizard can skip collecting them.
|
|
1893
|
+
* Org variables always override the default.
|
|
1894
|
+
*/
|
|
1895
|
+
has_default_app_credentials?: boolean;
|
|
1877
1896
|
config_schema?: Attribute[];
|
|
1878
1897
|
methods: ConnectorMethod[];
|
|
1879
1898
|
origin: 'pre_built' | 'custom';
|
|
@@ -1893,6 +1912,11 @@ interface ConnectorConnection {
|
|
|
1893
1912
|
scope: ConnectionScope$1;
|
|
1894
1913
|
owner?: UserRef$1;
|
|
1895
1914
|
external_account_id: string;
|
|
1915
|
+
/** Redacted {kind, data} credential envelope — secrets are masked; use kind to tell how the connection authenticates. */
|
|
1916
|
+
credentials?: {
|
|
1917
|
+
kind: CredentialKind;
|
|
1918
|
+
data?: Record<string, unknown>;
|
|
1919
|
+
};
|
|
1896
1920
|
settings: Record<string, unknown>;
|
|
1897
1921
|
status: ConnectionStatus$1;
|
|
1898
1922
|
status_detail?: string;
|
|
@@ -2013,7 +2037,7 @@ type Channel = 'slack' | 'email' | 'linkedin' | 'sms' | 'teams-chat' | 'telegram
|
|
|
2013
2037
|
* meeting-bot family: adhoc-meeting dispatches by meeting URL; the calendar
|
|
2014
2038
|
* keys auto-join through a user's connected calendar.
|
|
2015
2039
|
*/
|
|
2016
|
-
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';
|
|
2040
|
+
type ConnectorKey = 'slack' | 'gmail' | 'outlook' | 'echo' | 'unipile-whatsapp' | 'unipile-linkedin' | 'unipile-telegram' | 'unipile-instagram' | 'unipile-messenger' | 'unipile-x' | 'adhoc-meeting' | 'google-calendar-meeting' | 'microsoft-calendar-meeting';
|
|
2017
2041
|
/**
|
|
2018
2042
|
* Who operates the integration mechanics behind a connector: Proteos' own
|
|
2019
2043
|
* integration (native), an account aggregated through Unipile (unipile), or
|
|
@@ -2034,6 +2058,15 @@ type ConnectionStatus = 'pending' | 'active' | 'error' | 'revoked';
|
|
|
2034
2058
|
* drafting) — hidden from the default list until the first successful send.
|
|
2035
2059
|
*/
|
|
2036
2060
|
type ConversationStatus = 'active' | 'ended' | 'archived' | 'draft';
|
|
2061
|
+
/**
|
|
2062
|
+
* Generation lifecycle of a conversation's `summary`. `none` is the resting
|
|
2063
|
+
* default — no summary exists and none is being produced, the state of every
|
|
2064
|
+
* conversation that is not a transcript-backed meeting. `processing` is claimed
|
|
2065
|
+
* for the duration of one generation run (automatic at transcript attach, or a
|
|
2066
|
+
* manual `meetings.summarize()`), so any client can render "Summarizing…"
|
|
2067
|
+
* without having started the run itself.
|
|
2068
|
+
*/
|
|
2069
|
+
type ConversationSummaryStatus = 'none' | 'processing' | 'completed' | 'failed';
|
|
2037
2070
|
type AgentListenerTriggerType = 'always' | 'mention' | 'channel' | 'keyword';
|
|
2038
2071
|
interface UserRef {
|
|
2039
2072
|
type: string;
|
|
@@ -2156,6 +2189,16 @@ interface Conversation {
|
|
|
2156
2189
|
* conversations, editable via update(). Absent when no summary exists.
|
|
2157
2190
|
*/
|
|
2158
2191
|
summary?: string;
|
|
2192
|
+
/**
|
|
2193
|
+
* Generation lifecycle of `summary`. Poll `conversations.get(id)` while this
|
|
2194
|
+
* reads `processing` to pick up the finished summary.
|
|
2195
|
+
*/
|
|
2196
|
+
summary_status: ConversationSummaryStatus;
|
|
2197
|
+
/**
|
|
2198
|
+
* When the current `processing` run was claimed; absent otherwise. Bounds the
|
|
2199
|
+
* claim server-side and gives clients an elapsed time to show.
|
|
2200
|
+
*/
|
|
2201
|
+
summary_started_at?: string;
|
|
2159
2202
|
status: ConversationStatus;
|
|
2160
2203
|
/**
|
|
2161
2204
|
* Room directory row a room-borne thread (Slack channel conversation) lives
|
|
@@ -2978,10 +3021,17 @@ interface MeetingService {
|
|
|
2978
3021
|
/** Make the bot leave the meeting and end the conversation (by conversation id). */
|
|
2979
3022
|
remove(conversationId: string): Promise<Conversation>;
|
|
2980
3023
|
/**
|
|
2981
|
-
*
|
|
2982
|
-
* transcript, overwriting any existing one
|
|
2983
|
-
*
|
|
2984
|
-
* conversation
|
|
3024
|
+
* START regenerating this meeting conversation's markdown summary from its
|
|
3025
|
+
* stored transcript, overwriting any existing one when it lands. Generation
|
|
3026
|
+
* runs server-side beyond this request, so the promise resolves as soon as the
|
|
3027
|
+
* conversation is CLAIMED — with `summary_status: 'processing'` and the OLD
|
|
3028
|
+
* `summary` still attached. Poll `conversations.get(id)` until
|
|
3029
|
+
* `summary_status` is `completed` (or `failed`) to read the new one.
|
|
3030
|
+
*
|
|
3031
|
+
* Rejects with `no_transcript` when the conversation has no completed
|
|
3032
|
+
* transcript to summarize, `summarization_unavailable` when the environment
|
|
3033
|
+
* has no generator configured, and `summary_in_progress` when a generation is
|
|
3034
|
+
* already running for this conversation.
|
|
2985
3035
|
*/
|
|
2986
3036
|
summarize(conversationId: string): Promise<Conversation>;
|
|
2987
3037
|
}
|
|
@@ -5281,7 +5331,9 @@ type NodeRuntime = 'go' | 'wasm' | 'intrinsic';
|
|
|
5281
5331
|
/** Coarse catalog grouping of a node type. */
|
|
5282
5332
|
type NodeGroup = 'trigger' | 'action' | 'transform' | 'flow';
|
|
5283
5333
|
/** Control type of one descriptor property (n8n INodeProperties paradigm). */
|
|
5284
|
-
type PropertyType = 'string' | 'number' | 'boolean' | 'options' | 'multi_options' | 'json' | 'date_time' | 'color' | 'notice' | 'hidden' | 'collection' | 'fixed_collection' | 'credentials_select' | 'button'
|
|
5334
|
+
type PropertyType = 'string' | 'number' | 'boolean' | 'options' | 'multi_options' | 'json' | 'date_time' | 'color' | 'notice' | 'hidden' | 'collection' | 'fixed_collection' | 'credentials_select' | 'button'
|
|
5335
|
+
/** Edits a platform attribute list (`Attribute[]`) via the shared attribute schema builder. */
|
|
5336
|
+
| 'attribute_schema' | 'resource_locator' | 'resource_mapper' | 'filter' | 'assignment_collection';
|
|
5285
5337
|
/**
|
|
5286
5338
|
* One named input or output port. Port keys are stable identifiers referenced
|
|
5287
5339
|
* by connections (never indexes).
|
|
@@ -5442,45 +5494,35 @@ interface MessageTriggerParams {
|
|
|
5442
5494
|
}
|
|
5443
5495
|
type KickoffType = 'message' | 'outcome';
|
|
5444
5496
|
/**
|
|
5445
|
-
* Where a kickoff draws its instruction text from: typed inline
|
|
5446
|
-
* resolved from a reusable agent-service Prompt by key
|
|
5497
|
+
* Where a kickoff slot draws its instruction text from: typed inline
|
|
5498
|
+
* (`manual`) or resolved from a reusable agent-service Prompt by key
|
|
5499
|
+
* (`prompt`) at run time.
|
|
5447
5500
|
*/
|
|
5448
5501
|
type KickoffSource = 'manual' | 'prompt';
|
|
5449
|
-
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
|
|
5454
|
-
|
|
5455
|
-
|
|
5456
|
-
|
|
5457
|
-
|
|
5458
|
-
|
|
5459
|
-
|
|
5460
|
-
|
|
5461
|
-
|
|
5462
|
-
type: 'text' | 'file';
|
|
5463
|
-
content?: string;
|
|
5464
|
-
file_id?: string;
|
|
5465
|
-
}
|
|
5466
|
-
interface OutcomeKickoff {
|
|
5467
|
-
/** Description and rubric are independently sourced (manual vs prompt). */
|
|
5502
|
+
/**
|
|
5503
|
+
* Flat, descriptor-driven parameters of the `action.agent` node (gated by
|
|
5504
|
+
* display_options on `kickoff_type` / `*_source`). `output_schema` declares
|
|
5505
|
+
* the node's structured output as platform attributes — the agent records it
|
|
5506
|
+
* via the session-scoped `set_output` tool; `is_output_required` fails the
|
|
5507
|
+
* node when the agent finishes without setting it.
|
|
5508
|
+
*/
|
|
5509
|
+
interface AgentActionParams {
|
|
5510
|
+
agent_key: string;
|
|
5511
|
+
kickoff_type: KickoffType;
|
|
5512
|
+
message_source?: KickoffSource;
|
|
5513
|
+
message_text?: string;
|
|
5514
|
+
message_prompt_key?: string;
|
|
5468
5515
|
description_source?: KickoffSource;
|
|
5469
5516
|
description?: string;
|
|
5470
5517
|
description_prompt_key?: string;
|
|
5471
5518
|
rubric_source?: KickoffSource;
|
|
5472
|
-
|
|
5519
|
+
rubric_type?: 'text' | 'file';
|
|
5520
|
+
rubric_content?: string;
|
|
5521
|
+
rubric_file_id?: string;
|
|
5473
5522
|
rubric_prompt_key?: string;
|
|
5474
5523
|
max_iterations?: number;
|
|
5475
|
-
|
|
5476
|
-
|
|
5477
|
-
type: KickoffType;
|
|
5478
|
-
message?: MessageKickoff;
|
|
5479
|
-
outcome?: OutcomeKickoff;
|
|
5480
|
-
}
|
|
5481
|
-
interface AgentActionParams {
|
|
5482
|
-
agent_key: string;
|
|
5483
|
-
kickoff: AgentKickoff;
|
|
5524
|
+
output_schema?: Attribute[];
|
|
5525
|
+
is_output_required?: boolean;
|
|
5484
5526
|
}
|
|
5485
5527
|
interface Workflow extends AuditFields {
|
|
5486
5528
|
org_id: string;
|
|
@@ -5805,4 +5847,4 @@ declare class WorkflowClient {
|
|
|
5805
5847
|
constructor(client: ProteosClient);
|
|
5806
5848
|
}
|
|
5807
5849
|
|
|
5808
|
-
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type AddressFilterConfig, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type
|
|
5850
|
+
export { AccountClient, type Action, type ActionBinding, ActionSchema, type ActionScope, ActionScopeSchema, type ActionService, type AddressFilterConfig, type Agent, type AgentActionParams, type AgentArtifactsPayload, AgentClient, type AgentListener, type AgentListenerService, type AgentListenerTriggerType, type AgentMessagePayload, type AgentResourceListOptions, type AgentService, type AllFilterConfig, type ApiErrorResponse, type AppendEventRequest, type AssignPermissionRequest, type AssignRoleRequest, type AttachContactAddressRequest, type Attachment, Attribute, AuditFields, type AuthListOptions, type AutomatedFilterConfig, type AutomatedSignal, type BatchTransactionError, BatchTransactionErrorSchema, type BatchTransactionStatus, type BatchUpsertRecordsResponse, BatchUpsertRecordsResponseSchema, type BatchUpsertTransaction, type BatchUpsertTransactionResult, BatchUpsertTransactionResultSchema, BatchUpsertTransactionSchema, type BinaryRef, type BlockContactRequest, type Channel, type ClientEventType, type ClientToolSchema, type Connection, type ConnectionCredentials, type ConnectionEndpoint, type ConnectionScope, type ConnectionService, type ConnectionStatus, type Connector, ConnectorClient, type ConnectorConnection, type ConnectionScope$1 as ConnectorConnectionScope, type ConnectionStatus$1 as ConnectorConnectionStatus, type ConnectionTokenResponse as ConnectorConnectionTokenResponse, type CredentialKind as ConnectorCredentialKind, type ConnectorKey, type ConnectorMethod, type ConnectorProvider, type ConsentStatus, type ConsumerGroup, type Contact, type ContactAddress, type ContactAddressKind, type ContactAddressSource, type ContactErasureRequest, type ContactMergeProposal, type ContactRef, type ContactService, type ContactSource, type ContactStatus, type ContentBlock$1 as ContentBlock, type ContentMatch, type ContentResponse, type ContextCompactedPayload, type Conversation, ConversationClient, type ConversationFilter, type ConversationFilterAction, type ConversationFilterConfig, type ConversationFilterEvent, type ConversationFilterService, type ConversationFilterType, type ConversationParticipant, type ConversationService, type ConversationStatus, type ConversationSummaryStatus, type CreateAgentListenerRequest, type CreateAgentRequest, type CreateConnectionRequest, type CreateConnectorConnectionRequest, type CreateConversationFilterRequest, 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 DependentAgent, type DependentSyncResult, type DispatchMeetingBotRequest, type DisplayOptions, type DomainFilterConfig, ERROR_PORT, type EditContentRequest, type EditContentResponse, type EmptyPayload, type ErasureRequestStatus, 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, type FilterMatchOn, FunctionsClient, type GetExecutionDetailResponse, type GetGraphOptions, type GetNodeExecutionItemsOptions, type GetNodeExecutionItemsResponse, type GetNodeTypesResponse, type GlossaryTerm, type GlossaryTermService, type GraphService, type InlineLinkRequest, type InstallConnectionResponse, type InstallConnectorConnectionResponse, type InternalConversationsFilterConfig, 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 ListContactAddressesQuery, type ListContactMergeProposalsQuery, type ListContactsQuery, type ListConversationFilterEventsQuery, type ListConversationFiltersQuery, type ListConversationsQuery, type ListEventsOptions, type ListExecutionsOptions, type ListGlossaryTermsQuery, type ListLabelsOptions, type ListLinksOptions, type ListMcpServersOptions, type ListMessagesQuery, type ListNodesOptions, ListOptions, type ListOrganizationsOptions, type ListPromptsOptions, type ListRecordLinksOptions, type ListRecordsOptions, type 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 MergeContactsRequest, type MergeProposalStatus, type Message, type ContentBlock as MessageContentBlock, type MessageDirection, 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 OutlineHeading, type OutlineRequest, type OutlineResponse, PLATFORM_ENTITIES, PLATFORM_ENTITY_SLUGS, PageIterator, type PairedItem, type ParseStatus, type Permission, type PermissionEventSource, type PermissionEventType, type PlatformEntity, type PlatformEvent, type PortSpec, type Prompt, type PromptService, type PromptVersion, type PropertyOption, type PropertyType, ProteosClient, ProteosError, PublicAccessOperation, 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 RecordPermissionEventRequest, type RecordService, type RedriveResult, type ResultBlock, type Role, type RoleBasedFilterConfig, 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 UpdateContactRequest, type UpdateConversationFilterRequest, type UpdateDraftRequest, type UpdateFileMetadata, 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 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 };
|