@amigo-ai/sdk 1.0.0 → 1.1.0

package/dist/types/platform/resources/phone-numbers.d.ts

@@ -0,0 +1,170 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import type { components, operations } from '../../generated/platform-api-types';
+import type { WorkspaceId, PhoneNumberId } from '../core/branded-types';
+/** Resource for managing phone numbers. */
+export declare class PhoneNumberResource {
+    private c;
+    private workspaceId;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId);
+    /** List phone numbers in the workspace. */
+    list(options?: {
+        query?: operations['list-phone-numbers']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["PhoneNumberResponse"][];
+        total?: number | null;
+    }>;
+    /** Get a phone number by ID. */
+    get(options: {
+        phoneNumberId: PhoneNumberId;
+    }): Promise<{
+        capabilities: string[];
+        channel_phone_id?: string | null;
+        created_at: string;
+        display_name: string;
+        forwarding: components["schemas"]["ForwardingConfigResponse"] | null;
+        id: string;
+        inbound_service_id: string | null;
+        notes: string;
+        phone_number: string;
+        provider: string;
+        provider_phone_sid: string | null;
+        status: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Create a phone number. */
+    create(options: {
+        body: components['schemas']['CreatePhoneNumberRequest'];
+    }): Promise<{
+        capabilities: string[];
+        channel_phone_id?: string | null;
+        created_at: string;
+        display_name: string;
+        forwarding: components["schemas"]["ForwardingConfigResponse"] | null;
+        id: string;
+        inbound_service_id: string | null;
+        notes: string;
+        phone_number: string;
+        provider: string;
+        provider_phone_sid: string | null;
+        status: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Update a phone number. */
+    update(options: {
+        phoneNumberId: PhoneNumberId;
+        body: components['schemas']['UpdatePhoneNumberRequest'];
+    }): Promise<{
+        capabilities: string[];
+        channel_phone_id?: string | null;
+        created_at: string;
+        display_name: string;
+        forwarding: components["schemas"]["ForwardingConfigResponse"] | null;
+        id: string;
+        inbound_service_id: string | null;
+        notes: string;
+        phone_number: string;
+        provider: string;
+        provider_phone_sid: string | null;
+        status: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Delete a phone number. */
+    delete(options: {
+        phoneNumberId: PhoneNumberId;
+    }): Promise<void>;
+    /** Set call forwarding for a phone number. */
+    setForwarding(options: {
+        phoneNumberId: PhoneNumberId;
+        body: components['schemas']['ForwardingConfigRequest'];
+    }): Promise<{
+        capabilities: string[];
+        channel_phone_id?: string | null;
+        created_at: string;
+        display_name: string;
+        forwarding: components["schemas"]["ForwardingConfigResponse"] | null;
+        id: string;
+        inbound_service_id: string | null;
+        notes: string;
+        phone_number: string;
+        provider: string;
+        provider_phone_sid: string | null;
+        status: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Clear call forwarding for a phone number. */
+    clearForwarding(options: {
+        phoneNumberId: PhoneNumberId;
+    }): Promise<void>;
+    /** Get the Twilio sub-account for the workspace. */
+    getTwilioSubAccount(): Promise<{
+        account_sid: string;
+        created_at: string;
+        environment: string;
+        friendly_name: string;
+        id: string;
+        status?: string;
+        twiml_app_sid: string | null;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Provision a Twilio sub-account for the workspace. */
+    provisionTwilioSubAccount(): Promise<{
+        account_sid: string;
+        created_at: string;
+        environment: string;
+        friendly_name: string;
+        id: string;
+        status?: string;
+        twiml_app_sid: string | null;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+    /** Search available phone numbers for purchase. */
+    searchAvailable(options?: {
+        query?: operations['search-available-phone-numbers']['parameters']['query'];
+    }): Promise<{
+        numbers: components["schemas"]["AvailableNumber"][];
+    }>;
+    /** Purchase a phone number. */
+    purchase(options: {
+        body: components['schemas']['PurchasePhoneNumberRequest'];
+    }): Promise<{
+        capabilities: ("inbound" | "outbound")[];
+        created_at: string;
+        display_name: string;
+        id: string;
+        phone_number: string;
+        provider_phone_sid: string;
+        status: string;
+        workspace_id: string;
+    }>;
+    /** Release a purchased phone number. */
+    release(options: {
+        phoneNumberId: PhoneNumberId;
+    }): Promise<void>;
+    /** Bind a channel-manager phone number to a workspace/service. */
+    bind(options: {
+        body: components['schemas']['BindChannelPhoneRequest'];
+    }): Promise<{
+        capabilities: string[];
+        channel_phone_id?: string | null;
+        created_at: string;
+        display_name: string;
+        forwarding: components["schemas"]["ForwardingConfigResponse"] | null;
+        id: string;
+        inbound_service_id: string | null;
+        notes: string;
+        phone_number: string;
+        provider: string;
+        provider_phone_sid: string | null;
+        status: string;
+        updated_at: string;
+        workspace_id: string;
+    }>;
+}

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

@@ -0,0 +1,133 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import type { components, operations } from '../../generated/platform-api-types';
+import type { WorkspaceId, PlatformServiceId } from '../core/branded-types';
+/** Resource for managing services. */
+export declare class PlatformServiceResource {
+    private c;
+    private workspaceId;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId);
+    /** List services in the workspace. */
+    list(options?: {
+        query?: operations['list-services']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["ServiceResponse"][];
+        total?: number | null;
+    }>;
+    /** Get a service by ID. */
+    get(options: {
+        serviceId: PlatformServiceId;
+    }): Promise<{
+        agent_id: string;
+        agent_name?: string | null;
+        channel_type?: "voice" | "text" | "scribe";
+        context_graph_id: string;
+        context_graph_name?: string | null;
+        created_at: string;
+        description: string;
+        environment?: "sandbox" | "production";
+        escalation_policy?: components["schemas"]["EscalationPolicy"] | null;
+        id: string;
+        is_active: boolean;
+        is_system?: boolean;
+        keyterms: string[];
+        name: string;
+        persona_id?: string | null;
+        persona_name?: string | null;
+        safety_filters_enabled?: boolean;
+        tags: components["schemas"]["ServiceTag"][];
+        tool_capacity: number;
+        updated_at: string;
+        version_sets: {
+            [key: string]: components["schemas"]["VersionSet"];
+        };
+        voice_config?: components["schemas"]["ServiceVoiceConfig"] | null;
+        workspace_id: string;
+    }>;
+    /** Create a new service. */
+    create(options: {
+        body: components['schemas']['CreateServiceRequest'];
+    }): Promise<{
+        agent_id: string;
+        agent_name?: string | null;
+        channel_type?: "voice" | "text" | "scribe";
+        context_graph_id: string;
+        context_graph_name?: string | null;
+        created_at: string;
+        description: string;
+        environment?: "sandbox" | "production";
+        escalation_policy?: components["schemas"]["EscalationPolicy"] | null;
+        id: string;
+        is_active: boolean;
+        is_system?: boolean;
+        keyterms: string[];
+        name: string;
+        persona_id?: string | null;
+        persona_name?: string | null;
+        safety_filters_enabled?: boolean;
+        tags: components["schemas"]["ServiceTag"][];
+        tool_capacity: number;
+        updated_at: string;
+        version_sets: {
+            [key: string]: components["schemas"]["VersionSet"];
+        };
+        voice_config?: components["schemas"]["ServiceVoiceConfig"] | null;
+        workspace_id: string;
+    }>;
+    /** Update a service. */
+    update(options: {
+        serviceId: PlatformServiceId;
+        body: components['schemas']['UpdateServiceRequest'];
+    }): Promise<{
+        agent_id: string;
+        agent_name?: string | null;
+        channel_type?: "voice" | "text" | "scribe";
+        context_graph_id: string;
+        context_graph_name?: string | null;
+        created_at: string;
+        description: string;
+        environment?: "sandbox" | "production";
+        escalation_policy?: components["schemas"]["EscalationPolicy"] | null;
+        id: string;
+        is_active: boolean;
+        is_system?: boolean;
+        keyterms: string[];
+        name: string;
+        persona_id?: string | null;
+        persona_name?: string | null;
+        safety_filters_enabled?: boolean;
+        tags: components["schemas"]["ServiceTag"][];
+        tool_capacity: number;
+        updated_at: string;
+        version_sets: {
+            [key: string]: components["schemas"]["VersionSet"];
+        };
+        voice_config?: components["schemas"]["ServiceVoiceConfig"] | null;
+        workspace_id: string;
+    }>;
+    /** Delete a service. */
+    delete(options: {
+        serviceId: PlatformServiceId;
+    }): Promise<void>;
+    /** Upsert a version set for a service. */
+    upsertVersionSet(options: {
+        serviceId: PlatformServiceId;
+        name: string;
+        body: components['schemas']['UpsertVersionSetRequest'];
+    }): Promise<never>;
+    /** Resolve all tools available to a service. */
+    resolveTools(options: {
+        serviceId: PlatformServiceId;
+        query?: operations['resolve-service-tools']['parameters']['query'];
+    }): Promise<{
+        service_id: string;
+        tools: components["schemas"]["ResolvedToolItem"][];
+        workspace_id: string;
+    }>;
+    /** Run one voice turn through a service. */
+    voiceTurn(options: {
+        serviceId: PlatformServiceId;
+        body: components['schemas']['Body_voice-turn'] | FormData;
+    }): Promise<{}>;
+}

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

@@ -0,0 +1,61 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import { type PlatformWebSocketConstructor, type PlatformWebSocketLike } from '../core/websocket';
+import type { components } from '../../generated/platform-api-types';
+import type { CallSid, EntityId, PlatformServiceId, WorkspaceId } from '../core/branded-types';
+export interface PlatformSessionSocketOptions {
+    serviceId: PlatformServiceId | string;
+    entityId: EntityId | string;
+    conversationId?: string;
+    toolEvents?: boolean;
+    token?: string;
+    WebSocket?: PlatformWebSocketConstructor;
+}
+interface PlatformSessionRealtimeConfig {
+    apiKey: string;
+    webSocketBaseUrl: string;
+    WebSocket?: PlatformWebSocketConstructor;
+}
+/** Resource for active sessions, text-session starts, injection, and WebSocket connect. */
+export declare class PlatformSessionResource {
+    private c;
+    private workspaceId;
+    private realtime;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId, realtime: PlatformSessionRealtimeConfig);
+    /** List active voice sessions. */
+    listActive(): Promise<{
+        call_sid: string;
+        caller_id: string;
+        current_state?: string;
+        direction: string;
+        duration_seconds: number;
+        scenario?: string;
+        service_id: string;
+        workspace_id: string;
+    }[]>;
+    /** Start an SMS, WhatsApp, or web text session with an entity. */
+    start(options: {
+        body: components['schemas']['StartSessionRequest'];
+    }): Promise<{
+        channel_kind: "sms" | "whatsapp" | "web";
+        conversation_id: string;
+        created_at: string;
+        entity_id: string;
+        phone_from?: string | null;
+        phone_to?: string | null;
+        service_id: string;
+        session_status: "created" | "resumed" | "already_active";
+    }>;
+    /** Inject an external event or operator guidance into an active voice session. */
+    inject(options: {
+        callSid: CallSid | string;
+        body: components['schemas']['InjectRequest'];
+    }): Promise<{
+        call_sid: string;
+        status: "delivered" | "queued_no_subscriber";
+    }>;
+    /** Build the public platform text-session WebSocket URL. */
+    buildTextSessionUrl(options: Omit<PlatformSessionSocketOptions, 'token' | 'WebSocket'>): string;
+    /** Connect to the public bidirectional text-session WebSocket. */
+    connectTextSession(options: PlatformSessionSocketOptions): PlatformWebSocketLike;
+}
+export {};

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

@@ -0,0 +1,169 @@
+import type { PlatformFetch } from '../core/openapi-client';
+import type { components, operations } from '../../generated/platform-api-types';
+import type { WorkspaceId, SkillId } from '../core/branded-types';
+/** Resource for managing skills. */
+export declare class SkillResource {
+    private c;
+    private workspaceId;
+    constructor(c: PlatformFetch, workspaceId: WorkspaceId);
+    /** List skills in the workspace. */
+    list(options?: {
+        query?: operations['list-skills']['parameters']['query'];
+    }): Promise<{
+        continuation_token?: number | null;
+        has_more: boolean;
+        items: components["schemas"]["SkillResponse"][];
+        total?: number | null;
+    }>;
+    /** Get a skill by ID. */
+    get(options: {
+        skillId: SkillId;
+    }): Promise<{
+        approval_required: boolean;
+        browser_allowed_domains: string[];
+        browser_auth_integration: string | null;
+        browser_start_url: string | null;
+        checkpoint_enabled: boolean;
+        created_at: string;
+        delivery: "interrupt" | "queue";
+        description: string;
+        enable_caching: boolean;
+        enable_citations: boolean;
+        enabled: boolean;
+        execution_tier: "direct" | "orchestrated" | "autonomous" | "browser" | "computer_use";
+        id: string;
+        input_schema: {
+            [key: string]: unknown;
+        };
+        integration_tools: components["schemas"]["src__models__IntegrationToolRef"][];
+        max_agent_turns: number;
+        max_input_tokens: number | null;
+        max_result_chars: number;
+        max_tokens: number;
+        model: string;
+        name: string;
+        result_schema: {
+            [key: string]: unknown;
+        } | null;
+        slug: string;
+        static_tools: components["schemas"]["src__models__StaticToolDef"][];
+        system_prompt: string;
+        thinking_effort: ("low" | "medium" | "high") | null;
+        timeout_s: number;
+        updated_at: string;
+        urgency_keywords: string[];
+        use_structured_output: boolean;
+        version: number;
+        workspace_id: string;
+    }>;
+    /** Create a new skill. */
+    create(options: {
+        body: components['schemas']['CreateSkillRequest'];
+    }): Promise<{
+        approval_required: boolean;
+        browser_allowed_domains: string[];
+        browser_auth_integration: string | null;
+        browser_start_url: string | null;
+        checkpoint_enabled: boolean;
+        created_at: string;
+        delivery: "interrupt" | "queue";
+        description: string;
+        enable_caching: boolean;
+        enable_citations: boolean;
+        enabled: boolean;
+        execution_tier: "direct" | "orchestrated" | "autonomous" | "browser" | "computer_use";
+        id: string;
+        input_schema: {
+            [key: string]: unknown;
+        };
+        integration_tools: components["schemas"]["src__models__IntegrationToolRef"][];
+        max_agent_turns: number;
+        max_input_tokens: number | null;
+        max_result_chars: number;
+        max_tokens: number;
+        model: string;
+        name: string;
+        result_schema: {
+            [key: string]: unknown;
+        } | null;
+        slug: string;
+        static_tools: components["schemas"]["src__models__StaticToolDef"][];
+        system_prompt: string;
+        thinking_effort: ("low" | "medium" | "high") | null;
+        timeout_s: number;
+        updated_at: string;
+        urgency_keywords: string[];
+        use_structured_output: boolean;
+        version: number;
+        workspace_id: string;
+    }>;
+    /** Update a skill. */
+    update(options: {
+        skillId: SkillId;
+        body: components['schemas']['UpdateSkillRequest'];
+    }): Promise<{
+        approval_required: boolean;
+        browser_allowed_domains: string[];
+        browser_auth_integration: string | null;
+        browser_start_url: string | null;
+        checkpoint_enabled: boolean;
+        created_at: string;
+        delivery: "interrupt" | "queue";
+        description: string;
+        enable_caching: boolean;
+        enable_citations: boolean;
+        enabled: boolean;
+        execution_tier: "direct" | "orchestrated" | "autonomous" | "browser" | "computer_use";
+        id: string;
+        input_schema: {
+            [key: string]: unknown;
+        };
+        integration_tools: components["schemas"]["src__models__IntegrationToolRef"][];
+        max_agent_turns: number;
+        max_input_tokens: number | null;
+        max_result_chars: number;
+        max_tokens: number;
+        model: string;
+        name: string;
+        result_schema: {
+            [key: string]: unknown;
+        } | null;
+        slug: string;
+        static_tools: components["schemas"]["src__models__StaticToolDef"][];
+        system_prompt: string;
+        thinking_effort: ("low" | "medium" | "high") | null;
+        timeout_s: number;
+        updated_at: string;
+        urgency_keywords: string[];
+        use_structured_output: boolean;
+        version: number;
+        workspace_id: string;
+    }>;
+    /** Delete a skill. */
+    delete(options: {
+        skillId: SkillId;
+    }): Promise<void>;
+    /** Test a skill in isolation. */
+    test(options: {
+        skillId: SkillId;
+        body: components['schemas']['TestSkillRequest'];
+    }): Promise<{
+        cached_tokens: number;
+        duration_ms: number;
+        error?: string | null;
+        input_tokens: number;
+        output_tokens: number;
+        result: string;
+        rounds: number;
+        sub_tool_logs: components["schemas"]["SubToolLog"][];
+    }>;
+    /** Get HSM/service references for a skill. */
+    getReferences(options: {
+        skillId: SkillId;
+    }): Promise<{
+        context_graph_references: components["schemas"]["SkillContextGraphReference"][];
+        service_references: string[];
+        skill_id: string;
+        skill_slug: string;
+    }>;
+}