pollax 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,795 @@
+import { AxiosRequestConfig } from 'axios';
+
+/**
+ * Agent configuration and types
+ */
+interface Agent {
+    id: string;
+    name: string;
+    description?: string;
+    system_prompt: string;
+    provider: 'openai' | 'anthropic' | 'ollama';
+    model: string;
+    voice_provider?: 'elevenlabs' | 'openai' | 'google';
+    voice_id?: string;
+    stt_provider?: 'deepgram' | 'whisper' | 'google';
+    temperature?: number;
+    max_tokens?: number;
+    is_active: boolean;
+    tenant_id: string;
+    config?: Record<string, any>;
+    created_at: string;
+    updated_at: string;
+    calls_count?: number;
+    success_rate?: string;
+    avg_duration?: string;
+}
+interface CreateAgentParams {
+    name: string;
+    system_prompt: string;
+    description?: string;
+    provider?: 'openai' | 'anthropic' | 'ollama';
+    model?: string;
+    voice_provider?: 'elevenlabs' | 'openai' | 'google';
+    voice_id?: string;
+    stt_provider?: 'deepgram' | 'whisper' | 'google';
+    temperature?: number;
+    max_tokens?: number;
+    config?: Record<string, any>;
+}
+interface UpdateAgentParams {
+    name?: string;
+    description?: string;
+    system_prompt?: string;
+    provider?: 'openai' | 'anthropic' | 'ollama';
+    model?: string;
+    voice_provider?: 'elevenlabs' | 'openai' | 'google';
+    voice_id?: string;
+    is_active?: boolean;
+    config?: Record<string, any>;
+}
+interface ListAgentsParams {
+    is_active?: boolean;
+    skip?: number;
+    limit?: number;
+}
+/**
+ * Call types
+ */
+interface Call {
+    call_sid: string;
+    agent_id: string;
+    to_number: string;
+    from_number?: string;
+    status: 'queued' | 'ringing' | 'in-progress' | 'completed' | 'failed' | 'busy' | 'no-answer';
+    direction: 'inbound' | 'outbound';
+    duration?: number;
+    start_time?: string;
+    end_time?: string;
+    recording_url?: string;
+    transcript?: string;
+    metadata?: Record<string, any>;
+    created_at: string;
+    agent_name?: string;
+}
+interface CreateCallParams {
+    agent_id: string;
+    to_number: string;
+    from_number?: string;
+    metadata?: Record<string, any>;
+}
+interface ListCallsParams {
+    agent_id?: string;
+    status?: string;
+    skip?: number;
+    limit?: number;
+}
+/**
+ * Campaign types
+ */
+interface Campaign {
+    id: string;
+    name: string;
+    agent_id?: string;
+    agent_name?: string;
+    status: 'draft' | 'scheduled' | 'running' | 'paused' | 'completed' | 'cancelled';
+    scheduled_time?: string;
+    contacts: Array<{
+        name?: string;
+        phone: string;
+        email?: string;
+        metadata?: Record<string, any>;
+    }>;
+    total_contacts: number;
+    completed_calls: number;
+    successful_calls: number;
+    failed_calls: number;
+    tenant_id: string;
+    created_at: string;
+    updated_at: string;
+}
+interface CreateCampaignParams {
+    name: string;
+    agent_id?: string;
+    scheduled_time?: string;
+    contacts?: Array<{
+        name?: string;
+        phone: string;
+        email?: string;
+        metadata?: Record<string, any>;
+    }>;
+}
+interface UpdateCampaignParams {
+    name?: string;
+    agent_id?: string;
+    status?: 'draft' | 'scheduled' | 'running' | 'paused' | 'completed' | 'cancelled';
+    scheduled_time?: string;
+}
+/**
+ * Knowledge Base types
+ */
+interface KnowledgeDocument {
+    id: string;
+    name: string;
+    type: 'pdf' | 'txt' | 'docx' | 'url';
+    content?: string;
+    url?: string;
+    chunks_count: number;
+    status: 'processing' | 'ready' | 'failed';
+    tenant_id: string;
+    created_at: string;
+}
+interface UploadDocumentParams {
+    name: string;
+    file?: File | Buffer;
+    content?: string;
+    url?: string;
+    type?: 'pdf' | 'txt' | 'docx' | 'url';
+}
+/**
+ * Analytics types
+ */
+interface DashboardStats {
+    total_calls: number;
+    active_agents: number;
+    success_rate: string;
+    avg_duration: string;
+    calls_by_status: Record<string, number>;
+}
+interface CallVolumeData {
+    period: string;
+    data: Array<{
+        timestamp: string;
+        count: number;
+    }>;
+}
+/**
+ * Integration types
+ */
+interface Integration {
+    id: string;
+    name: string;
+    type: 'twilio' | 'salesforce' | 'hubspot' | 'slack' | 'zapier' | 'webhook';
+    config: Record<string, any>;
+    is_active: boolean;
+    tenant_id: string;
+    created_at: string;
+    updated_at: string;
+}
+interface CreateIntegrationParams {
+    name: string;
+    type: 'twilio' | 'salesforce' | 'hubspot' | 'slack' | 'zapier' | 'webhook';
+    config: Record<string, any>;
+}
+/**
+ * Phone Number types
+ */
+interface PhoneNumber {
+    id: string;
+    phone_number: string;
+    country_code: string;
+    capabilities: {
+        voice: boolean;
+        sms: boolean;
+    };
+    is_active: boolean;
+    tenant_id: string;
+    created_at: string;
+}
+interface SearchPhoneNumbersParams {
+    country_code?: string;
+    area_code?: string;
+    contains?: string;
+    limit?: number;
+}
+/**
+ * API Key types
+ */
+interface ApiKey {
+    id: string;
+    name: string;
+    key_prefix: string;
+    last_used_at?: string;
+    is_active: boolean;
+    created_at: string;
+}
+interface CreateApiKeyParams {
+    name: string;
+    permissions?: string[];
+}
+/**
+ * Voice Cloning types
+ */
+interface VoiceProfile {
+    id: string;
+    name: string;
+    description?: string;
+    voice_id: string;
+    provider: 'elevenlabs' | 'openai';
+    status: 'training' | 'ready' | 'failed';
+    tenant_id: string;
+    created_at: string;
+}
+interface CreateVoiceProfileParams {
+    name: string;
+    description?: string;
+    audio_files: File[] | Buffer[];
+    provider?: 'elevenlabs' | 'openai';
+}
+
+declare class Agents {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Create a new AI agent
+     *
+     * @example
+     * const agent = await pollax.agents.create({
+     *   name: 'Customer Support Agent',
+     *   system_prompt: 'You are a helpful customer support agent.',
+     *   voice_id: 'alloy',
+     *   model: 'gpt-4',
+     * });
+     */
+    create(params: CreateAgentParams): Promise<Agent>;
+    /**
+     * List all agents
+     *
+     * @example
+     * const agents = await pollax.agents.list({ is_active: true });
+     */
+    list(params?: ListAgentsParams): Promise<Agent[]>;
+    /**
+     * Get a single agent by ID
+     *
+     * @example
+     * const agent = await pollax.agents.retrieve('agent_123');
+     */
+    retrieve(agentId: string): Promise<Agent>;
+    /**
+     * Update an agent
+     *
+     * @example
+     * const agent = await pollax.agents.update('agent_123', {
+     *   name: 'Updated Agent Name',
+     *   is_active: false,
+     * });
+     */
+    update(agentId: string, params: UpdateAgentParams): Promise<Agent>;
+    /**
+     * Delete an agent
+     *
+     * @example
+     * await pollax.agents.delete('agent_123');
+     */
+    delete(agentId: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Test an agent with a sample prompt
+     *
+     * @example
+     * const response = await pollax.agents.test('agent_123', {
+     *   message: 'Hello, how can you help me?',
+     * });
+     */
+    test(agentId: string, params: {
+        message: string;
+    }): Promise<{
+        response: string;
+    }>;
+}
+
+declare class Calls {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Create a new voice call
+     *
+     * @example
+     * const call = await pollax.calls.create({
+     *   agent_id: 'agent_123',
+     *   to_number: '+1234567890',
+     * });
+     */
+    create(params: CreateCallParams): Promise<Call>;
+    /**
+     * List all calls
+     *
+     * @example
+     * const calls = await pollax.calls.list({
+     *   agent_id: 'agent_123',
+     *   status: 'completed',
+     * });
+     */
+    list(params?: ListCallsParams): Promise<Call[]>;
+    /**
+     * Get a single call by SID
+     *
+     * @example
+     * const call = await pollax.calls.retrieve('CA123456789');
+     */
+    retrieve(callSid: string): Promise<Call>;
+    /**
+     * End an active call
+     *
+     * @example
+     * await pollax.calls.end('CA123456789');
+     */
+    end(callSid: string): Promise<Call>;
+    /**
+     * Transfer a call to another number
+     *
+     * @example
+     * await pollax.calls.transfer('CA123456789', {
+     *   to_number: '+1234567890',
+     * });
+     */
+    transfer(callSid: string, params: {
+        to_number: string;
+    }): Promise<Call>;
+    /**
+     * Get call transcript
+     *
+     * @example
+     * const transcript = await pollax.calls.getTranscript('CA123456789');
+     */
+    getTranscript(callSid: string): Promise<{
+        transcript: string;
+        messages: any[];
+    }>;
+    /**
+     * Get call recording URL
+     *
+     * @example
+     * const recording = await pollax.calls.getRecording('CA123456789');
+     */
+    getRecording(callSid: string): Promise<{
+        url: string;
+    }>;
+}
+
+declare class Campaigns {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Create a new campaign
+     *
+     * @example
+     * const campaign = await pollax.campaigns.create({
+     *   name: 'Q1 Outreach Campaign',
+     *   agent_id: 'agent_123',
+     *   contacts: [
+     *     { name: 'John Doe', phone: '+1234567890' },
+     *     { name: 'Jane Smith', phone: '+0987654321' },
+     *   ],
+     * });
+     */
+    create(params: CreateCampaignParams): Promise<Campaign>;
+    /**
+     * List all campaigns
+     *
+     * @example
+     * const campaigns = await pollax.campaigns.list();
+     */
+    list(): Promise<Campaign[]>;
+    /**
+     * Get a single campaign by ID
+     *
+     * @example
+     * const campaign = await pollax.campaigns.retrieve('campaign_123');
+     */
+    retrieve(campaignId: string): Promise<Campaign>;
+    /**
+     * Update a campaign
+     *
+     * @example
+     * const campaign = await pollax.campaigns.update('campaign_123', {
+     *   status: 'paused',
+     * });
+     */
+    update(campaignId: string, params: UpdateCampaignParams): Promise<Campaign>;
+    /**
+     * Delete a campaign
+     *
+     * @example
+     * await pollax.campaigns.delete('campaign_123');
+     */
+    delete(campaignId: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Start a campaign
+     *
+     * @example
+     * await pollax.campaigns.start('campaign_123');
+     */
+    start(campaignId: string): Promise<Campaign>;
+    /**
+     * Pause a running campaign
+     *
+     * @example
+     * await pollax.campaigns.pause('campaign_123');
+     */
+    pause(campaignId: string): Promise<Campaign>;
+    /**
+     * Upload contacts to a campaign via CSV
+     *
+     * @example
+     * const campaign = await pollax.campaigns.uploadContacts('campaign_123', csvFile);
+     */
+    uploadContacts(campaignId: string, file: File | Buffer): Promise<Campaign>;
+    /**
+     * Get campaign statistics
+     *
+     * @example
+     * const stats = await pollax.campaigns.getStats('campaign_123');
+     */
+    getStats(campaignId: string): Promise<{
+        total_contacts: number;
+        completed_calls: number;
+        successful_calls: number;
+        failed_calls: number;
+        success_rate: string;
+    }>;
+}
+
+declare class Knowledge {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Upload a document to the knowledge base
+     *
+     * @example
+     * const doc = await pollax.knowledge.upload({
+     *   name: 'Product Manual',
+     *   file: pdfFile,
+     *   type: 'pdf',
+     * });
+     */
+    upload(params: UploadDocumentParams): Promise<KnowledgeDocument>;
+    /**
+     * List all knowledge documents
+     *
+     * @example
+     * const documents = await pollax.knowledge.list();
+     */
+    list(): Promise<KnowledgeDocument[]>;
+    /**
+     * Get a single document by ID
+     *
+     * @example
+     * const doc = await pollax.knowledge.retrieve('doc_123');
+     */
+    retrieve(documentId: string): Promise<KnowledgeDocument>;
+    /**
+     * Delete a document
+     *
+     * @example
+     * await pollax.knowledge.delete('doc_123');
+     */
+    delete(documentId: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Search the knowledge base
+     *
+     * @example
+     * const results = await pollax.knowledge.search({
+     *   query: 'How do I reset my password?',
+     *   limit: 5,
+     * });
+     */
+    search(params: {
+        query: string;
+        limit?: number;
+    }): Promise<{
+        results: Array<{
+            document_id: string;
+            content: string;
+            score: number;
+        }>;
+    }>;
+}
+
+declare class Analytics {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Get dashboard statistics
+     *
+     * @example
+     * const stats = await pollax.analytics.getStats();
+     */
+    getStats(): Promise<DashboardStats>;
+    /**
+     * Get call volume over time
+     *
+     * @example
+     * const volume = await pollax.analytics.getCallVolume({ period: '7d' });
+     */
+    getCallVolume(params?: {
+        period?: '24h' | '7d' | '30d';
+    }): Promise<CallVolumeData>;
+    /**
+     * Get agent performance metrics
+     *
+     * @example
+     * const performance = await pollax.analytics.getAgentPerformance('agent_123');
+     */
+    getAgentPerformance(agentId: string): Promise<{
+        total_calls: number;
+        success_rate: string;
+        avg_duration: string;
+        total_minutes: number;
+    }>;
+    /**
+     * Export analytics data
+     *
+     * @example
+     * const csvData = await pollax.analytics.export({
+     *   start_date: '2024-01-01',
+     *   end_date: '2024-01-31',
+     *   format: 'csv',
+     * });
+     */
+    export(params: {
+        start_date: string;
+        end_date: string;
+        format?: 'csv' | 'json';
+    }): Promise<string | object>;
+}
+
+declare class Integrations {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Create a new integration
+     *
+     * @example
+     * const integration = await pollax.integrations.create({
+     *   name: 'Salesforce CRM',
+     *   type: 'salesforce',
+     *   config: {
+     *     client_id: '...',
+     *     client_secret: '...',
+     *   },
+     * });
+     */
+    create(params: CreateIntegrationParams): Promise<Integration>;
+    /**
+     * List all integrations
+     *
+     * @example
+     * const integrations = await pollax.integrations.list();
+     */
+    list(): Promise<Integration[]>;
+    /**
+     * Get a single integration by ID
+     *
+     * @example
+     * const integration = await pollax.integrations.retrieve('int_123');
+     */
+    retrieve(integrationId: string): Promise<Integration>;
+    /**
+     * Delete an integration
+     *
+     * @example
+     * await pollax.integrations.delete('int_123');
+     */
+    delete(integrationId: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class PhoneNumbers {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * List all phone numbers
+     *
+     * @example
+     * const numbers = await pollax.phoneNumbers.list();
+     */
+    list(): Promise<PhoneNumber[]>;
+    /**
+     * Search available phone numbers
+     *
+     * @example
+     * const numbers = await pollax.phoneNumbers.search({
+     *   country_code: 'US',
+     *   area_code: '415',
+     * });
+     */
+    search(params: SearchPhoneNumbersParams): Promise<PhoneNumber[]>;
+    /**
+     * Purchase a phone number
+     *
+     * @example
+     * const number = await pollax.phoneNumbers.purchase('+14155551234');
+     */
+    purchase(phoneNumber: string): Promise<PhoneNumber>;
+    /**
+     * Release a phone number
+     *
+     * @example
+     * await pollax.phoneNumbers.release('num_123');
+     */
+    release(numberId: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class ApiKeys {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Create a new API key
+     *
+     * @example
+     * const apiKey = await pollax.apiKeys.create({
+     *   name: 'Production Key',
+     *   permissions: ['read', 'write'],
+     * });
+     */
+    create(params: CreateApiKeyParams): Promise<ApiKey & {
+        key: string;
+    }>;
+    /**
+     * List all API keys
+     *
+     * @example
+     * const keys = await pollax.apiKeys.list();
+     */
+    list(): Promise<ApiKey[]>;
+    /**
+     * Revoke an API key
+     *
+     * @example
+     * await pollax.apiKeys.revoke('key_123');
+     */
+    revoke(keyId: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+declare class VoiceCloning {
+    private request;
+    constructor(request: <T = any>(config: AxiosRequestConfig) => Promise<T>);
+    /**
+     * Create a new voice profile
+     *
+     * @example
+     * const voice = await pollax.voiceCloning.create({
+     *   name: 'Custom Voice',
+     *   description: 'My custom voice profile',
+     *   audio_files: [audioFile1, audioFile2],
+     * });
+     */
+    create(params: CreateVoiceProfileParams): Promise<VoiceProfile>;
+    /**
+     * List all voice profiles
+     *
+     * @example
+     * const voices = await pollax.voiceCloning.list();
+     */
+    list(): Promise<VoiceProfile[]>;
+    /**
+     * Get a single voice profile by ID
+     *
+     * @example
+     * const voice = await pollax.voiceCloning.retrieve('voice_123');
+     */
+    retrieve(voiceId: string): Promise<VoiceProfile>;
+    /**
+     * Delete a voice profile
+     *
+     * @example
+     * await pollax.voiceCloning.delete('voice_123');
+     */
+    delete(voiceId: string): Promise<{
+        success: boolean;
+    }>;
+}
+
+interface PollaxConfig {
+    /**
+     * Your Pollax API key (required)
+     * Get it from https://pollax.ai/settings/api-keys
+     */
+    apiKey: string;
+    /**
+     * Base URL for the Pollax API
+     * @default 'https://api.pollax.ai'
+     */
+    baseURL?: string;
+    /**
+     * Request timeout in milliseconds
+     * @default 30000
+     */
+    timeout?: number;
+    /**
+     * Maximum number of retry attempts
+     * @default 3
+     */
+    maxRetries?: number;
+    /**
+     * Organization/tenant ID (optional)
+     * If provided, all requests will be scoped to this organization
+     */
+    tenantId?: string;
+}
+declare class Pollax {
+    private client;
+    private maxRetries;
+    readonly agents: Agents;
+    readonly calls: Calls;
+    readonly campaigns: Campaigns;
+    readonly knowledge: Knowledge;
+    readonly analytics: Analytics;
+    readonly integrations: Integrations;
+    readonly phoneNumbers: PhoneNumbers;
+    readonly apiKeys: ApiKeys;
+    readonly voiceCloning: VoiceCloning;
+    constructor(config: PollaxConfig);
+    /**
+     * Make an HTTP request with automatic retries
+     */
+    request<T = any>(config: AxiosRequestConfig, retries?: number): Promise<T>;
+    private sleep;
+}
+
+/**
+ * Custom error class for Pollax API errors
+ */
+declare class PollaxError extends Error {
+    readonly statusCode: number;
+    readonly response?: any;
+    constructor(message: string, statusCode?: number, response?: any);
+}
+/**
+ * Error thrown when authentication fails
+ */
+declare class AuthenticationError extends PollaxError {
+    constructor(message?: string, response?: any);
+}
+/**
+ * Error thrown when a requested resource is not found
+ */
+declare class NotFoundError extends PollaxError {
+    constructor(message?: string, response?: any);
+}
+/**
+ * Error thrown when rate limit is exceeded
+ */
+declare class RateLimitError extends PollaxError {
+    constructor(message?: string, response?: any);
+}
+/**
+ * Error thrown for validation errors
+ */
+declare class ValidationError extends PollaxError {
+    constructor(message?: string, response?: any);
+}
+
+export { type Agent, Agents, Analytics, type ApiKey, ApiKeys, AuthenticationError, type Call, type CallVolumeData, Calls, type Campaign, Campaigns, type CreateAgentParams, type CreateApiKeyParams, type CreateCallParams, type CreateCampaignParams, type CreateIntegrationParams, type CreateVoiceProfileParams, type DashboardStats, type Integration, Integrations, Knowledge, type KnowledgeDocument, type ListAgentsParams, type ListCallsParams, NotFoundError, type PhoneNumber, PhoneNumbers, Pollax, type PollaxConfig, PollaxError, RateLimitError, type SearchPhoneNumbersParams, type UpdateAgentParams, type UpdateCampaignParams, type UploadDocumentParams, ValidationError, VoiceCloning, type VoiceProfile, Pollax as default };