@amigo-ai/sdk 1.0.0 → 1.1.0

package/dist/types/platform/core/auth.d.ts

@@ -0,0 +1,6 @@
+import type { Middleware } from 'openapi-fetch';
+/**
+ * Create a middleware that sets the Authorization header with a raw API key.
+ * Platform API uses simple Bearer token auth — no token exchange needed.
+ */
+export declare function createPlatformAuthMiddleware(apiKey: string): Middleware;

package/dist/types/platform/core/branded-types.d.ts

@@ -0,0 +1,59 @@
+declare const __brand: unique symbol;
+type Brand<T, B extends string> = T & {
+    readonly [__brand]: B;
+};
+/** A branded string representing a Workspace ID. */
+export type WorkspaceId = Brand<string, 'WorkspaceId'>;
+/** A branded string representing a Skill ID. */
+export type SkillId = Brand<string, 'SkillId'>;
+/** A branded string representing an Integration ID. */
+export type IntegrationId = Brand<string, 'IntegrationId'>;
+/** A branded string representing an HSM ID. */
+export type HsmId = Brand<string, 'HsmId'>;
+/** A branded string representing a Context Graph ID. */
+export type ContextGraphId = Brand<string, 'ContextGraphId'>;
+/** A branded string representing a Platform Agent ID. */
+export type PlatformAgentId = Brand<string, 'PlatformAgentId'>;
+/** A branded string representing a Platform Service ID. */
+export type PlatformServiceId = Brand<string, 'PlatformServiceId'>;
+/** A branded string representing a Phone Number ID. */
+export type PhoneNumberId = Brand<string, 'PhoneNumberId'>;
+/** A branded string representing a Platform API Key ID. */
+export type PlatformApiKeyId = Brand<string, 'PlatformApiKeyId'>;
+/** A branded string representing a Call SID. */
+export type CallSid = Brand<string, 'CallSid'>;
+/** A branded string representing a Platform Conversation ID. */
+export type PlatformConversationId = Brand<string, 'PlatformConversationId'>;
+/** A branded string representing a Data Source ID. */
+export type DataSourceId = Brand<string, 'DataSourceId'>;
+/** A branded string representing an Operator ID. */
+export type OperatorId = Brand<string, 'OperatorId'>;
+/** A branded string representing a Review Item ID. */
+export type ReviewItemId = Brand<string, 'ReviewItemId'>;
+/** A branded string representing a Monitor Concept ID. */
+export type MonitorConceptId = Brand<string, 'MonitorConceptId'>;
+/** A branded string representing a Unification Rule ID. */
+export type UnificationRuleId = Brand<string, 'UnificationRuleId'>;
+/** A branded string representing an Entity ID. */
+export type EntityId = Brand<string, 'EntityId'>;
+/** A branded string representing a Task ID. */
+export type TaskId = Brand<string, 'TaskId'>;
+export declare function workspaceId(id: string): WorkspaceId;
+export declare function skillId(id: string): SkillId;
+export declare function integrationId(id: string): IntegrationId;
+export declare function hsmId(id: string): HsmId;
+export declare function contextGraphId(id: string): ContextGraphId;
+export declare function platformAgentId(id: string): PlatformAgentId;
+export declare function platformServiceId(id: string): PlatformServiceId;
+export declare function phoneNumberId(id: string): PhoneNumberId;
+export declare function platformApiKeyId(id: string): PlatformApiKeyId;
+export declare function callSid(id: string): CallSid;
+export declare function platformConversationId(id: string): PlatformConversationId;
+export declare function dataSourceId(id: string): DataSourceId;
+export declare function operatorId(id: string): OperatorId;
+export declare function reviewItemId(id: string): ReviewItemId;
+export declare function monitorConceptId(id: string): MonitorConceptId;
+export declare function unificationRuleId(id: string): UnificationRuleId;
+export declare function entityId(id: string): EntityId;
+export declare function taskId(id: string): TaskId;
+export {};

package/dist/types/platform/core/openapi-client.d.ts

@@ -0,0 +1,6 @@
+import type { Client } from 'openapi-fetch';
+import type { paths } from '../../generated/platform-api-types';
+import type { PlatformClientConfig } from '..';
+export type PlatformFetch = Client<paths>;
+/** Create an OpenAPI-typed fetch client for the Platform API. */
+export declare function createPlatformFetch(config: PlatformClientConfig, mockFetch?: typeof fetch): PlatformFetch;

package/dist/types/platform/core/websocket.d.ts

@@ -0,0 +1,8 @@
+export interface PlatformWebSocketLike {
+    close(code?: number, reason?: string): void;
+    send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
+    readonly readyState: number;
+}
+export type PlatformWebSocketConstructor = new (url: string, protocols?: string | string[]) => PlatformWebSocketLike;
+export declare function webSocketBaseFromHttpBase(baseUrl: string): string;
+export declare function getWebSocketConstructor(override?: PlatformWebSocketConstructor): PlatformWebSocketConstructor;

package/dist/types/platform/index.d.ts

@@ -0,0 +1,59 @@
+import type { RetryOptions } from '../core/retry';
+import { createPlatformFetch, type PlatformFetch } from './core/openapi-client';
+import { type PlatformWebSocketConstructor } from './core/websocket';
+import { PlatformAgentResource } from './resources/agents';
+import { PlatformApiKeyResource } from './resources/api-keys';
+import { ContextGraphResource } from './resources/context-graphs';
+import { PlatformConversationResource } from './resources/conversations';
+import { DataSourceResource } from './resources/data-sources';
+import { PlatformEventResource } from './resources/events';
+import { FhirResource } from './resources/fhir';
+import { IntegrationResource } from './resources/integrations';
+import { PhoneNumberResource } from './resources/phone-numbers';
+import { PlatformServiceResource } from './resources/services';
+import { PlatformSessionResource } from './resources/sessions';
+import { SkillResource } from './resources/skills';
+import { WorkspaceResource } from './resources/workspaces';
+import type { WorkspaceId } from './core/branded-types';
+export interface PlatformClientConfig {
+    /** Platform API key or JWT. */
+    apiKey: string;
+    /** Workspace ID used by workspace-scoped resources. */
+    workspaceId: WorkspaceId;
+    /** Platform API base URL. */
+    baseUrl?: string;
+    /** Platform WebSocket base URL. Defaults to `baseUrl` with ws/wss protocol. */
+    webSocketBaseUrl?: string;
+    /** Retry configuration for HTTP requests. */
+    retry?: RetryOptions;
+    /** Fetch implementation override for tests or non-standard runtimes. */
+    fetch?: typeof fetch;
+    /** WebSocket constructor override for Node runtimes without global WebSocket. */
+    WebSocket?: PlatformWebSocketConstructor;
+}
+/** Main client for the workspace-scoped Amigo Platform API. */
+export declare class PlatformClient {
+    readonly api: PlatformFetch;
+    readonly agents: PlatformAgentResource;
+    readonly apiKeys: PlatformApiKeyResource;
+    readonly contextGraphs: ContextGraphResource;
+    readonly conversations: PlatformConversationResource;
+    readonly dataSources: DataSourceResource;
+    readonly events: PlatformEventResource;
+    readonly fhir: FhirResource;
+    readonly integrations: IntegrationResource;
+    readonly phoneNumbers: PhoneNumberResource;
+    readonly services: PlatformServiceResource;
+    readonly sessions: PlatformSessionResource;
+    readonly skills: SkillResource;
+    readonly workspaces: WorkspaceResource;
+    readonly config: Required<Pick<PlatformClientConfig, 'apiKey' | 'workspaceId' | 'baseUrl' | 'webSocketBaseUrl'>> & Omit<PlatformClientConfig, 'apiKey' | 'workspaceId' | 'baseUrl' | 'webSocketBaseUrl'>;
+    constructor(config: PlatformClientConfig);
+}
+export { createPlatformFetch };
+export type { PlatformFetch, PlatformWebSocketConstructor };
+export type { ServerSentEvent } from '../core/utils';
+export { AmigoError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, ServerError, ServiceUnavailableError, ConfigurationError, ValidationError, NetworkError, ParseError, isAmigoError, } from '../core/errors';
+export type { components, operations, paths } from '../generated/platform-api-types';
+export type { CallSid, ContextGraphId, DataSourceId, EntityId, IntegrationId, MonitorConceptId, OperatorId, PhoneNumberId, PlatformAgentId, PlatformApiKeyId, PlatformConversationId, PlatformServiceId, ReviewItemId, SkillId, TaskId, UnificationRuleId, WorkspaceId, } from './core/branded-types';
+export { callSid, contextGraphId, dataSourceId, entityId, integrationId, monitorConceptId, operatorId, phoneNumberId, platformAgentId, platformApiKeyId, platformConversationId, platformServiceId, reviewItemId, skillId, taskId, unificationRuleId, workspaceId, } from './core/branded-types';

package/dist/types/platform/resources/agents.d.ts

@@ -0,0 +1,107 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import type { components, operations } from '../../generated/platform-api-types';
+import type { WorkspaceId, PlatformAgentId } from '../core/branded-types';
+/** Resource for managing platform agents. */
+export declare class PlatformAgentResource {
+    private c;
+    private workspaceId;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId);
+    /** List agents in the workspace. */
+    list(options?: {
+        query?: operations['list-agents']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["AgentResponse"][];
+        total?: number | null;
+    }>;
+    /** Get an agent by ID. */
+    get(options: {
+        agentId: PlatformAgentId;
+    }): Promise<{
+        created_at: string;
+        description: string;
+        id: string;
+        latest_version?: number;
+        name: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Create a new agent. */
+    create(options: {
+        body: components['schemas']['CreateAgentRequest'];
+    }): Promise<{
+        created_at: string;
+        description: string;
+        id: string;
+        latest_version?: number;
+        name: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Update an agent. */
+    update(options: {
+        agentId: PlatformAgentId;
+        body: components['schemas']['UpdateAgentRequest'];
+    }): Promise<{
+        created_at: string;
+        description: string;
+        id: string;
+        latest_version?: number;
+        name: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Delete an agent. */
+    delete(options: {
+        agentId: PlatformAgentId;
+    }): Promise<void>;
+    /** List agent versions. */
+    listVersions(options: {
+        agentId: PlatformAgentId;
+        query?: operations['list-agent-versions']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["AgentVersionResponse"][];
+        total?: number | null;
+    }>;
+    /** Get a specific agent version, or pass `"latest"` for the most recent version. */
+    getVersion(options: {
+        agentId: PlatformAgentId;
+        version: number | 'latest';
+    }): Promise<{
+        agent_id: string;
+        background: string;
+        behaviors: string[];
+        communication_patterns: string[];
+        created_at: string;
+        id: string;
+        identity: components["schemas"]["Identity"];
+        initials: string;
+        name: string;
+        updated_at: string;
+        version: number;
+        voice_config: components["schemas"]["VoiceConfig"] | null;
+        workspace_id: string;
+    }>;
+    /** Create a new agent version. */
+    createVersion(options: {
+        agentId: PlatformAgentId;
+        body: components['schemas']['CreateAgentVersionRequest'];
+    }): Promise<{
+        agent_id: string;
+        background: string;
+        behaviors: string[];
+        communication_patterns: string[];
+        created_at: string;
+        id: string;
+        identity: components["schemas"]["Identity"];
+        initials: string;
+        name: string;
+        updated_at: string;
+        version: number;
+        voice_config: components["schemas"]["VoiceConfig"] | null;
+        workspace_id: string;
+    }>;
+}

package/dist/types/platform/resources/api-keys.d.ts

@@ -0,0 +1,57 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import type { components, operations } from '../../generated/platform-api-types';
+import type { WorkspaceId, PlatformApiKeyId } from '../core/branded-types';
+/** Resource for managing API keys. */
+export declare class PlatformApiKeyResource {
+    private c;
+    private workspaceId;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId);
+    /** Get information about the currently authenticated API key. */
+    me(): Promise<{
+        expires_at: string;
+        expires_in_seconds: number;
+        key_id: string;
+        name: string | null;
+        workspace_id: string;
+    }>;
+    /** List API keys in the workspace. */
+    list(options?: {
+        query?: operations['list-api-keys']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["ApiKeyResponse"][];
+        total?: number | null;
+    }>;
+    /** Create a new API key. */
+    create(options: {
+        body: components['schemas']['CreateApiKeyRequest'];
+    }): Promise<{
+        api_key: string;
+        created_by_credential_id: string | null;
+        created_by_entity_id: string | null;
+        expires_at: string;
+        key_id: string;
+        name: string | null;
+        permissions: string[];
+        role: string;
+    }>;
+    /** Delete an API key. */
+    delete(options: {
+        keyId: PlatformApiKeyId;
+    }): Promise<void>;
+    /** Rotate an API key and return the replacement secret. */
+    rotate(options: {
+        keyId: PlatformApiKeyId;
+        body: components['schemas']['RotateApiKeyRequest'];
+    }): Promise<{
+        api_key: string;
+        created_by_credential_id: string | null;
+        created_by_entity_id: string | null;
+        expires_at: string;
+        key_id: string;
+        name: string | null;
+        permissions: string[];
+        role: string;
+    }>;
+}

package/dist/types/platform/resources/context-graphs.d.ts

@@ -0,0 +1,114 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import type { components, operations } from '../../generated/platform-api-types';
+import type { ContextGraphId, WorkspaceId } from '../core/branded-types';
+/** Resource for managing platform context graphs. */
+export declare class ContextGraphResource {
+    private c;
+    private workspaceId;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId);
+    /** List context graphs in the workspace. */
+    list(options?: {
+        query?: operations['list-context_graphs']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["ContextGraphResponse"][];
+        total?: number | null;
+    }>;
+    /** Get a context graph by ID. */
+    get(options: {
+        contextGraphId: ContextGraphId;
+    }): Promise<{
+        created_at: string;
+        description: string;
+        id: string;
+        latest_version?: number;
+        name: string;
+        state_count?: number;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Create a new context graph. */
+    create(options: {
+        body: components['schemas']['CreateContextGraphRequest'];
+    }): Promise<{
+        created_at: string;
+        description: string;
+        id: string;
+        latest_version?: number;
+        name: string;
+        state_count?: number;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Update a context graph. */
+    update(options: {
+        contextGraphId: ContextGraphId;
+        body: components['schemas']['UpdateContextGraphRequest'];
+    }): Promise<{
+        created_at: string;
+        description: string;
+        id: string;
+        latest_version?: number;
+        name: string;
+        state_count?: number;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Delete a context graph. */
+    delete(options: {
+        contextGraphId: ContextGraphId;
+    }): Promise<void>;
+    /** List context graph versions. */
+    listVersions(options: {
+        contextGraphId: ContextGraphId;
+        query?: operations['list-context_graph-versions']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["ContextGraphVersionResponse"][];
+        total?: number | null;
+    }>;
+    /** Get a specific context graph version. */
+    getVersion(options: {
+        contextGraphId: ContextGraphId;
+        version: number | 'latest';
+    }): Promise<{
+        context_graph_id: string;
+        created_at: string;
+        description: string;
+        global_action_guidelines: string[];
+        global_boundary_constraints: string[];
+        global_intra_state_navigation_guidelines: string[];
+        id: string;
+        new_user_initial_state: string;
+        returning_user_initial_state: string;
+        states: components["schemas"]["ContextGraphState-Output"][];
+        terminal_state: string;
+        topology_description: string | null;
+        updated_at: string;
+        version: number;
+        workspace_id: string;
+    }>;
+    /** Create a new context graph version. */
+    createVersion(options: {
+        contextGraphId: ContextGraphId;
+        body: components['schemas']['CreateContextGraphVersionRequest'];
+    }): Promise<{
+        context_graph_id: string;
+        created_at: string;
+        description: string;
+        global_action_guidelines: string[];
+        global_boundary_constraints: string[];
+        global_intra_state_navigation_guidelines: string[];
+        id: string;
+        new_user_initial_state: string;
+        returning_user_initial_state: string;
+        states: components["schemas"]["ContextGraphState-Output"][];
+        terminal_state: string;
+        topology_description: string | null;
+        updated_at: string;
+        version: number;
+        workspace_id: string;
+    }>;
+}

package/dist/types/platform/resources/conversations.d.ts

@@ -0,0 +1,154 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import type { components, operations } from '../../generated/platform-api-types';
+import type { PlatformConversationId, WorkspaceId } from '../core/branded-types';
+/** Resource for managing unified platform conversations. */
+export declare class PlatformConversationResource {
+    private c;
+    private workspaceId;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId);
+    /** List voice and text conversations in the workspace. */
+    list(options?: {
+        query?: operations['list_conversations_v1__workspace_id__conversations_get']['parameters']['query'];
+    }): Promise<{
+        has_more: boolean;
+        items: components["schemas"]["src__routes__conversations__ConversationSummary"][];
+        total: number;
+    }>;
+    /** Create a text conversation. */
+    create(options: {
+        body: components['schemas']['CreateConversationRequest'];
+    }): Promise<{
+        call_sid?: string | null;
+        caller_id?: string | null;
+        channel_kind: "voice" | "sms" | "whatsapp" | "web" | "email";
+        completion_reason?: string | null;
+        created_at: string;
+        direction?: string | null;
+        duration_seconds?: number | null;
+        entity_id?: string | null;
+        escalation_status?: string | null;
+        final_state?: string | null;
+        has_recording?: boolean | null;
+        id: string;
+        phone_number?: string | null;
+        plan?: string | null;
+        quality_score?: number | null;
+        service_id?: string | null;
+        source?: string | null;
+        status: "active" | "frozen" | "closed" | "completed" | "in-progress" | "failed";
+        turn_count?: number;
+        turns?: components["schemas"]["ConversationTurn"][];
+        updated_at: string;
+        voice?: components["schemas"]["VoiceDetail"] | null;
+    }>;
+    /** Get a conversation detail by ID. */
+    get(options: {
+        conversationId: PlatformConversationId | string;
+    }): Promise<{
+        call_sid?: string | null;
+        caller_id?: string | null;
+        channel_kind: "voice" | "sms" | "whatsapp" | "web" | "email";
+        completion_reason?: string | null;
+        created_at: string;
+        direction?: string | null;
+        duration_seconds?: number | null;
+        entity_id?: string | null;
+        escalation_status?: string | null;
+        final_state?: string | null;
+        has_recording?: boolean | null;
+        id: string;
+        phone_number?: string | null;
+        plan?: string | null;
+        quality_score?: number | null;
+        service_id?: string | null;
+        source?: string | null;
+        status: "active" | "frozen" | "closed" | "completed" | "in-progress" | "failed";
+        turn_count?: number;
+        turns?: components["schemas"]["ConversationTurn"][];
+        updated_at: string;
+        voice?: components["schemas"]["VoiceDetail"] | null;
+    }>;
+    /** Close a text conversation. */
+    close(options: {
+        conversationId: PlatformConversationId | string;
+    }): Promise<void>;
+    /** Send a text turn and receive the full JSON response. */
+    createTurn(options: {
+        conversationId: PlatformConversationId | string;
+        body: components['schemas']['TurnRequest'];
+        query?: operations['create_turn_v1__workspace_id__conversations__conversation_id__turns_post']['parameters']['query'];
+    }): Promise<NonNullable<{
+        conversation_id: string;
+        event: "done";
+        status: string;
+        turn_count: number;
+    } | {
+        event: "error";
+        message: string;
+    } | {
+        event: "message";
+        role: string;
+        text: string;
+    } | {
+        conversation: components["schemas"]["TurnConversationSnapshot"];
+        input: components["schemas"]["ConversationTurn"];
+        output: components["schemas"]["ConversationTurn"][];
+        tool_calls?: components["schemas"]["ConversationToolCallDetail"][];
+        turn_id: string;
+    } | {
+        event: "token";
+        text: string;
+    } | {
+        call_id: string;
+        event: "tool_call_started";
+        input: string;
+        tool_name: string;
+    } | {
+        call_id: string;
+        event: "tool_call_completed";
+        result: string;
+        succeeded: boolean;
+        tool_name: string;
+    } | {
+        event: "thinking";
+        tier: number;
+        tier_name: string;
+    }>>;
+    /** Send a text turn and receive typed Server-Sent Events. */
+    streamTurn(options: {
+        conversationId: PlatformConversationId | string;
+        body: components['schemas']['TurnRequest'];
+        query?: operations['create_turn_v1__workspace_id__conversations__conversation_id__turns_post']['parameters']['query'];
+        signal?: AbortSignal;
+    }): Promise<AsyncGenerator<import("..").ServerSentEvent<{
+        conversation_id: string;
+        event: "done";
+        status: string;
+        turn_count: number;
+    } | {
+        event: "error";
+        message: string;
+    } | {
+        event: "message";
+        role: string;
+        text: string;
+    } | {
+        event: "token";
+        text: string;
+    } | {
+        call_id: string;
+        event: "tool_call_started";
+        input: string;
+        tool_name: string;
+    } | {
+        call_id: string;
+        event: "tool_call_completed";
+        result: string;
+        succeeded: boolean;
+        tool_name: string;
+    } | {
+        event: "thinking";
+        tier: number;
+        tier_name: string;
+    }>, any, any>>;
+}