@customyai/customy-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,487 @@
+interface CustomyClientConfig {
+    /** API key (sk-...) */
+    apiKey: string;
+    /** Base URL of the Customy Agent API */
+    baseUrl: string;
+    /** Default timeout in ms (default: 30000) */
+    timeout?: number;
+    /** Custom fetch implementation */
+    fetch?: typeof fetch;
+}
+interface PaginatedResponse<T> {
+    data: T[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+    };
+}
+interface TaskCreateOptions {
+    name: string;
+    instructions: string;
+    agentId?: string;
+    skills?: string[];
+    sessions?: string[];
+    priority?: "low" | "normal" | "high" | "critical";
+    taskType?: "one_off" | "recurring" | "workflow_step";
+    trigger?: {
+        type: "cron" | "webhook" | "event" | "ai" | "manual";
+        expression?: string;
+        timezone?: string;
+        condition?: string;
+    };
+}
+interface NLTaskResult {
+    agentId: string;
+    name: string;
+    instructions: string;
+    description?: string;
+    skills: string[];
+    sessions: string[];
+    trigger?: {
+        type: string;
+        expression?: string;
+        timezone?: string;
+        condition?: string;
+    };
+    priority: string;
+    taskType: string;
+    confidence: number;
+    reasoning: string;
+}
+interface TemplateSummary {
+    id: string;
+    name: string;
+    description: string;
+    vertical: string;
+    icon: string;
+    color: string;
+    tags: string[];
+}
+interface AgentTemplate extends TemplateSummary {
+    baseAgentId: string;
+    suggestedModel: string;
+    suggestedSkills: string[];
+    suggestedSessions: string[];
+    systemPromptAddition: string;
+    personality: {
+        tone: string;
+        language: string;
+        emoji: boolean;
+    };
+    sampleTasks: Array<{
+        name: string;
+        prompt: string;
+        description: string;
+    }>;
+    suggestedTriggers: Array<{
+        name: string;
+        type: string;
+        config: Record<string, unknown>;
+        description: string;
+    }>;
+}
+interface MarketplaceListing {
+    id: string;
+    skillId: string;
+    title: string;
+    shortDescription: string;
+    longDescription?: string;
+    category: string;
+    tags: string[];
+    vertical?: string;
+    pricingType: string;
+    priceCredits: number;
+    installCount: number;
+    avgRating: number;
+    reviewCount: number;
+    status: string;
+    version: string;
+    publisherName: string;
+    publisherVerified: boolean;
+}
+interface MarketplaceInstall {
+    id: string;
+    listingId: string;
+    organizationId: string;
+    environmentId: string;
+    installedVersion: string;
+    isEnabled: boolean;
+    listing?: MarketplaceListing;
+}
+interface AITriggerEvalResult {
+    triggered: boolean;
+    confidence: number;
+    reasoning: string;
+    extractedFacts: string[];
+}
+interface BrowserSession {
+    id: string;
+    organizationId: string;
+    environmentId: string;
+    name?: string;
+    platform: string;
+    accountIdentifier: string;
+    status: "pending_auth" | "active" | "expired" | "revoked";
+    sessionDataRef?: string;
+    userAgent?: string;
+    metadata?: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    lastUsedAt?: string;
+    expiresAt?: string;
+}
+interface BrowserSessionAccount {
+    id: string;
+    sessionId: string;
+    platform: string;
+    accountIdentifier: string;
+    status: "active" | "expired" | "logged_out";
+    authenticatedAt?: string;
+    lastVerifiedAt?: string;
+}
+interface AgentBrowserTask {
+    id: string;
+    organizationId: string;
+    environmentId: string;
+    agentRunId?: string;
+    sessionId?: string;
+    taskDescription: string;
+    taskType?: string;
+    status: "pending" | "running" | "waiting_human" | "completed" | "failed" | "cancelled" | "timeout";
+    progress?: number;
+    interruptionType?: "captcha" | "two_factor" | "login_required" | "security_check" | "manual_input" | "confirmation";
+    interruptionMessage?: string;
+    liveViewUrl?: string;
+    liveViewExpiresAt?: string;
+    currentUrl?: string;
+    result?: unknown;
+    screenshotRef?: string;
+    recordingRef?: string;
+    errorMessage?: string;
+    errorCode?: string;
+    createdAt: string;
+    startedAt?: string;
+    completedAt?: string;
+}
+interface PaymentIntentCreateOptions {
+    amountMinor: number;
+    currency: string;
+    description?: string;
+    provider?: string;
+    customerEmail?: string;
+    customerName?: string;
+    metadata?: Record<string, unknown>;
+}
+interface PaymentIntentResult {
+    id: string;
+    status: "pending" | "processing" | "succeeded" | "failed" | "cancelled";
+    amountMinor: number;
+    currency: string;
+    checkoutUrl?: string;
+    paymentLinkUrl?: string;
+    createdAt: string;
+}
+interface VoiceCallInitiateOptions {
+    agentId: string;
+    phoneNumber: string;
+    dynamicVariables?: Record<string, string>;
+    recordAudio?: boolean;
+}
+interface VoiceCallResult {
+    callId: string;
+    agentId: string;
+    status: "queued" | "initiated" | "in_progress" | "completed" | "failed";
+    durationSeconds?: number;
+    transcript?: string;
+    summary?: string;
+    recordingUrl?: string;
+    createdAt: string;
+}
+interface CRMContactCreateOptions {
+    email?: string;
+    phone?: string;
+    fullName?: string;
+    companyName?: string;
+    stage?: string;
+    tags?: string[];
+    customFields?: Record<string, unknown>;
+}
+interface CRMContactResult {
+    id: string;
+    email?: string;
+    phone?: string;
+    fullName?: string;
+    companyName?: string;
+    stage?: string;
+    tags?: string[];
+    createdAt: string;
+}
+interface EventPublishOptions {
+    eventType: string;
+    aggregateId?: string;
+    payload: Record<string, unknown>;
+    idempotencyKey?: string;
+}
+interface EventPublishResult {
+    eventId: string;
+    accepted: boolean;
+    publishedAt: string;
+}
+
+declare class CustomyClient {
+    private baseUrl;
+    private apiKey;
+    private timeout;
+    private fetchFn;
+    constructor(config: CustomyClientConfig);
+    private request;
+    tasks: {
+        /** Parse a natural language prompt into a structured task */
+        createFromNaturalLanguage: (prompt: string) => Promise<NLTaskResult>;
+        /** Create a task with explicit parameters */
+        create: (options: TaskCreateOptions) => Promise<{
+            id: string;
+        }>;
+        /** Get a task by ID */
+        get: (id: string) => Promise<Record<string, unknown>>;
+        /** List tasks with pagination */
+        list: (options?: {
+            page?: number;
+            limit?: number;
+            status?: string;
+        }) => Promise<{
+            tasks: Record<string, unknown>[];
+            total: number;
+        }>;
+    };
+    templates: {
+        /** List all available agent templates */
+        list: (options?: {
+            vertical?: string;
+            tag?: string;
+        }) => Promise<{
+            templates: TemplateSummary[];
+            total: number;
+        }>;
+        /** Get full template details */
+        get: (id: string) => Promise<AgentTemplate>;
+        /** Instantiate a template into an agent config */
+        instantiate: (templateId: string, options?: {
+            displayName?: string;
+            modelOverride?: string;
+        }) => Promise<{
+            message: string;
+            agentConfig: Record<string, unknown>;
+        }>;
+    };
+    marketplace: {
+        /** Browse marketplace listings */
+        browse: (options?: {
+            category?: string;
+            tag?: string;
+            sort?: string;
+            page?: number;
+            limit?: number;
+        }) => Promise<{
+            listings: MarketplaceListing[];
+            pagination: {
+                page: number;
+                limit: number;
+                total: number;
+            };
+        }>;
+        /** Get listing details */
+        get: (id: string) => Promise<MarketplaceListing>;
+        /** Install a skill from the marketplace */
+        install: (listingId: string) => Promise<MarketplaceInstall>;
+        /** Submit a review */
+        review: (listingId: string, review: {
+            rating: number;
+            title?: string;
+            body?: string;
+        }) => Promise<Record<string, unknown>>;
+        /** List installed skills */
+        installed: () => Promise<{
+            installs: MarketplaceInstall[];
+            total: number;
+        }>;
+    };
+    triggers: {
+        /** Create an AI-powered trigger */
+        createAI: (options: {
+            name: string;
+            condition: string;
+            workflowId?: string;
+            confidenceThreshold?: number;
+            cooldownMs?: number;
+        }) => Promise<Record<string, unknown>>;
+        /** Test an AI trigger evaluation */
+        evaluateAI: (options: {
+            condition: string;
+            data: unknown;
+            confidenceThreshold?: number;
+        }) => Promise<AITriggerEvalResult>;
+        /** List AI triggers */
+        listAI: () => Promise<{
+            triggers: Record<string, unknown>[];
+            total: number;
+        }>;
+    };
+    browser: {
+        sessions: {
+            /** List browser sessions */
+            list: (options?: {
+                platform?: string;
+                status?: string;
+            }) => Promise<{
+                sessions: BrowserSession[];
+                total: number;
+            }>;
+            /** Get a specific session */
+            get: (sessionId: string) => Promise<BrowserSession>;
+            /** Revoke a session manually */
+            revoke: (sessionId: string) => Promise<{
+                ok: boolean;
+                status: string;
+            }>;
+        };
+        tasks: {
+            /** List browser tasks */
+            list: (options?: {
+                taskId?: string;
+            }) => Promise<{
+                tasks: AgentBrowserTask[];
+                total: number;
+            }>;
+            /** Resume a task waiting for human input */
+            resume: (taskId: string, action: "continue" | "cancel") => Promise<{
+                ok: boolean;
+                taskId: string;
+                action: string;
+            }>;
+            /** Get tasks currently waiting for a human */
+            getWaiting: () => Promise<{
+                tasks: AgentBrowserTask[];
+            }>;
+        };
+        /**
+         * Helper: Executes a browser task and waits for its completion.
+         * Resolves when the task is 'completed', 'failed', 'cancelled', 'timeout',
+         * or 'waiting_human' (meaning it needs intervention).
+         */
+        executeAndWait: (taskId: string, pollIntervalMs?: number) => Promise<AgentBrowserTask>;
+    };
+    payments: {
+        /** Create a payment intent */
+        createIntent: (options: PaymentIntentCreateOptions) => Promise<PaymentIntentResult>;
+        /** Get payment intent status */
+        getIntent: (intentId: string) => Promise<PaymentIntentResult>;
+        /** List payment intents */
+        listIntents: (query?: {
+            limit?: string;
+            startingAfter?: string;
+        }) => Promise<PaginatedResponse<PaymentIntentResult>>;
+    };
+    voice: {
+        /** Initiate an autonomous voice call */
+        initiateCall: (options: VoiceCallInitiateOptions) => Promise<VoiceCallResult>;
+        /** Get voice call details and transcript */
+        getCall: (callId: string) => Promise<VoiceCallResult>;
+        /** List voice calls */
+        listCalls: (query?: {
+            agentId?: string;
+            limit?: string;
+        }) => Promise<PaginatedResponse<VoiceCallResult>>;
+    };
+    crm: {
+        /** Create or upsert a contact */
+        createContact: (options: CRMContactCreateOptions) => Promise<CRMContactResult>;
+        /** Get contact details */
+        getContact: (contactId: string) => Promise<CRMContactResult>;
+        /** List contacts */
+        listContacts: (query?: {
+            stage?: string;
+            limit?: string;
+        }) => Promise<PaginatedResponse<CRMContactResult>>;
+    };
+    events: {
+        /** Publish an event to the Customy Event Backbone */
+        publish: (options: EventPublishOptions) => Promise<EventPublishResult>;
+    };
+}
+
+/**
+ * Product/service SDK boundary for the Customy portfolio.
+ *
+ * This layer deliberately owns transport, auth and tenant-safe URL handling
+ * only. Domain methods belong in the SDK for the corresponding bounded
+ * context once that service publishes its OpenAPI contract.
+ */
+declare const CUSTOMY_PRODUCT_KEYS: readonly ["agent", "ads", "analytics", "atlas", "bookings", "campaigns", "commerce", "content", "crm", "data", "design", "domains", "engagement", "flows", "forms", "links", "mission-control", "pages", "payments", "send", "sitesight", "support", "tables", "tasks", "voice", "whatsapp", "work"];
+declare const CUSTOMY_PLATFORM_SERVICE_KEYS: readonly ["access", "audit", "billing", "events", "integrations", "realtime", "scheduler", "storage"];
+type CustomyProductKey = (typeof CUSTOMY_PRODUCT_KEYS)[number];
+type CustomyPlatformServiceKey = (typeof CUSTOMY_PLATFORM_SERVICE_KEYS)[number];
+type CustomySdkKey = CustomyProductKey | CustomyPlatformServiceKey;
+type CustomyHttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD";
+type CustomyQuery = Record<string, string | number | boolean | null | undefined | Array<string | number | boolean>>;
+type CustomySdkRequestOptions = {
+    query?: CustomyQuery;
+    body?: unknown;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+    timeoutMs?: number;
+    maxBytes?: number;
+};
+type CustomySdkConfig = {
+    /** Shared fallback URL. Prefer `baseUrls` for multi-service applications. */
+    baseUrl?: string;
+    baseUrls?: Partial<Record<CustomySdkKey, string>>;
+    apiKey?: string;
+    bearerToken?: string;
+    internalKey?: string;
+    headers?: Record<string, string>;
+    timeoutMs?: number;
+    fetch?: typeof fetch;
+};
+declare class CustomySdkError extends Error {
+    readonly product: CustomySdkKey;
+    readonly status: number;
+    readonly code: string;
+    readonly body?: unknown | undefined;
+    constructor(product: CustomySdkKey, status: number, code: string, body?: unknown | undefined);
+}
+/** One isolated client for one Customy bounded context. */
+declare class CustomyProductClient {
+    readonly product: CustomySdkKey;
+    private readonly configuredBaseUrl?;
+    private readonly config;
+    private readonly fetchImpl;
+    constructor(product: CustomySdkKey, config: CustomySdkConfig);
+    get baseUrl(): string;
+    request<TResponse = unknown>(method: CustomyHttpMethod, path: string, options?: CustomySdkRequestOptions): Promise<TResponse>;
+    get<TResponse = unknown>(path: string, options?: Omit<CustomySdkRequestOptions, "body">): Promise<TResponse>;
+    post<TResponse = unknown>(path: string, body?: unknown, options?: Omit<CustomySdkRequestOptions, "body">): Promise<TResponse>;
+    put<TResponse = unknown>(path: string, body?: unknown, options?: Omit<CustomySdkRequestOptions, "body">): Promise<TResponse>;
+    patch<TResponse = unknown>(path: string, body?: unknown, options?: Omit<CustomySdkRequestOptions, "body">): Promise<TResponse>;
+    delete<TResponse = unknown>(path: string, options?: Omit<CustomySdkRequestOptions, "body">): Promise<TResponse>;
+}
+type CustomyProductClients = {
+    [K in CustomySdkKey]: CustomyProductClient;
+};
+/** One install with isolated clients for every Customy product and platform service. */
+declare class CustomyPortfolioSdk {
+    readonly clients: CustomyProductClients;
+    readonly products: {
+        [K in CustomyProductKey]: CustomyProductClient;
+    };
+    readonly platform: {
+        [K in CustomyPlatformServiceKey]: CustomyProductClient;
+    };
+    constructor(config: CustomySdkConfig);
+    product<K extends CustomyProductKey>(key: K): CustomyProductClient;
+    service<K extends CustomyPlatformServiceKey>(key: K): CustomyProductClient;
+}
+declare const createCustomySdk: (config: CustomySdkConfig) => CustomyPortfolioSdk;
+
+export { type AITriggerEvalResult, type AgentBrowserTask, type BrowserSession, type BrowserSessionAccount, type CRMContactCreateOptions, type CRMContactResult, CUSTOMY_PLATFORM_SERVICE_KEYS, CUSTOMY_PRODUCT_KEYS, CustomyClient, type CustomyClientConfig, type CustomyHttpMethod, type CustomyPlatformServiceKey, CustomyPortfolioSdk, CustomyProductClient, type CustomyProductClients, type CustomyProductKey, type CustomyQuery, type CustomySdkConfig, CustomySdkError, type CustomySdkKey, type CustomySdkRequestOptions, type EventPublishOptions, type EventPublishResult, type MarketplaceInstall, type MarketplaceListing, type PaginatedResponse, type PaymentIntentCreateOptions, type PaymentIntentResult, type TaskCreateOptions, type VoiceCallInitiateOptions, type VoiceCallResult, createCustomySdk };