@palmyr/cli 1.0.0

package/dist/sdk.d.ts

@@ -0,0 +1,259 @@
+/**
+ * Palmyr SDK — programmatic access to all Palmyr services.
+ */
+export declare class Palmyr {
+    api: string;
+    token?: string;
+    passphrase?: string;
+    private autoPay;
+    constructor(apiUrl?: string, autoPay?: boolean, token?: string, passphrase?: string);
+    private request;
+    phoneSearch(country: string, limit?: number): Promise<any>;
+    phoneBuy(country: string, areaCode?: string): Promise<any>;
+    phoneSms(phoneId: string, to: string, body: string): Promise<any>;
+    phoneCall(phoneId: string, to: string, tts?: string): Promise<any>;
+    emailCreate(name: string, walletAddress?: string, domain?: string): Promise<any>;
+    emailListInboxes(): Promise<any>;
+    emailDomainStatus(domain: string): Promise<any>;
+    emailRegisterDomain(domain: string): Promise<any>;
+    emailRead(inboxId: string): Promise<any>;
+    emailSend(inboxId: string, to: string, subject: string, body: string): Promise<any>;
+    emailThreads(inboxId: string): Promise<any>;
+    computePlans(opts?: {
+        location?: string;
+    }): Promise<any>;
+    computeLocations(): Promise<any>;
+    /**
+     * Deploy a Hetzner Cloud server.
+     *
+     * `install` controls what cloud-init bootstraps on the server. When set
+     * (string or array), it overrides the legacy `installOpenClaw` boolean.
+     * Pass `[]` for a vanilla Ubuntu box (cloud-init skipped, password auth
+     * stays enabled). Discoverable via `GET /compute/install-recipes`.
+     *
+     * `location` picks a Hetzner datacenter slug (fsn1, nbg1, hel1, ash, hil,
+     * sin). The server validates type-vs-location compatibility pre-payment so
+     * cax11+ash fails as 400 with `Try one of: fsn1` instead of 422 after
+     * x402 settles. Discoverable via `GET /compute/locations`.
+     */
+    computeDeploy(name: string, serverType: string, opts?: {
+        sshPublicKey?: string;
+        sshKeyIds?: number[];
+        installOpenClaw?: boolean;
+        install?: string | string[];
+        location?: string;
+    }): Promise<any>;
+    /**
+     * Rename a deployed server. Metadata-only; doesn't reboot. Local server
+     * cache is updated by the CLI wrapper after a successful API call.
+     */
+    computeRename(serverId: string, newName: string): Promise<any>;
+    computeInstallRecipes(): Promise<any>;
+    computeList(): Promise<any>;
+    computeDelete(serverId: string): Promise<any>;
+    /**
+     * Inject your SSH public key into a freshly-deployed VPS, remove the
+     * platform's temporary key, and lock the root password. After this call,
+     * only your key can SSH into the box.
+     */
+    computeSetupSsh(serverId: string, publicKey: string): Promise<any>;
+    computeSshKeyAdd(name: string, publicKey: string): Promise<any>;
+    computeSshKeyList(): Promise<any>;
+    computeSshKeyDelete(id: number | string): Promise<any>;
+    computeGet(serverId: string): Promise<any>;
+    /**
+     * Run a single command on a freshly-deployed server via the platform's
+     * SSH key. Pre-handoff only — once `compute setup-ssh` has run we no
+     * longer have access. `command` and `args` are POSIX-quoted server-side
+     * so they pass through as distinct argv elements on the remote shell.
+     */
+    computeExec(serverId: string, command: string, args?: string[], opts?: {
+        timeoutSec?: number;
+    }): Promise<any>;
+    computeAction(serverId: string, action: string, opts?: {
+        image?: string;
+    }): Promise<any>;
+    domainCheck(domain: string): Promise<any>;
+    domainList(): Promise<any>;
+    domainPricing(domain: string): Promise<any>;
+    domainBuy(domain: string): Promise<any>;
+    domainDns(domain: string): Promise<any>;
+    domainTransferOwnership(domain: string, newOwner: string): Promise<any>;
+    walletCreate(label?: string, chains?: string[], mode?: 'unmanaged' | 'managed'): Promise<any>;
+    walletImport(mnemonic: string, label?: string, mode?: 'unmanaged' | 'managed'): Promise<any>;
+    walletList(): Promise<any>;
+    walletGet(walletId: string): Promise<any>;
+    walletDelete(walletId: string): Promise<any>;
+    walletAddresses(walletId: string): Promise<any>;
+    walletDerive(walletId: string, chain: string): Promise<any>;
+    /** Sign a transaction. Auth resolved from API key or session secret. */
+    walletSign(walletId: string, chain: string, transaction: string): Promise<any>;
+    walletSignMessage(walletId: string, chain: string, message: string): Promise<any>;
+    walletSignTyped(walletId: string, chain: string, typedData: string): Promise<any>;
+    walletPolicy(walletId: string, policy: {
+        per_tx_usdc?: number;
+        daily_usdc?: number;
+        allowed_chains?: string[];
+    }): Promise<any>;
+    walletGetPolicy(walletId: string): Promise<any>;
+    walletSpending(walletId: string): Promise<any>;
+    walletApiKey(walletId: string, name: string, sessionSecret: string, policyIds?: string[], expiresAt?: string): Promise<any>;
+    walletRevokeApiKey(walletId: string, keyId: string): Promise<any>;
+    walletConfig(walletId: string, sessionSecret: string): Promise<any>;
+    walletRequestApproval(walletId: string, action: string, params: Record<string, any>): Promise<any>;
+    socialTwitterLogin(accountId: string, login: string, password: string, totpSeed?: string, cookies?: {
+        auth_token?: string;
+        ct0?: string;
+    }, proxySessionId?: string): Promise<any>;
+    socialTwitterRegister(username: string, password: string, opts?: {
+        login?: string;
+        email?: string;
+        email_password?: string;
+        totp_seed?: string;
+        auth_token?: string;
+        ct0?: string;
+        country?: string;
+    }): Promise<any>;
+    socialTwitterUnregister(accountId: string): Promise<any>;
+    socialTwitterListRegistered(): Promise<any>;
+    socialScheduledPost(accountId: string, text: string, postAt: string, communityId?: string): Promise<any>;
+    socialScheduledThread(accountId: string, texts: string[], postAt: string, communityId?: string): Promise<any>;
+    socialScheduledMedia(accountId: string, text: string, media: Array<{
+        image_base64?: string;
+        image_url?: string;
+        video_base64?: string;
+        video_url?: string;
+    }>, postAt: string, communityId?: string): Promise<any>;
+    socialScheduledList(filter?: {
+        accountId?: string;
+        status?: 'pending' | 'in_progress' | 'completed' | 'failed' | 'cancelled';
+        from?: string;
+        to?: string;
+        limit?: number;
+    }): Promise<any>;
+    socialScheduledCancel(id: string): Promise<any>;
+    socialTwitterPost(accountId: string, cookies: any[], text: string, proxySessionId?: string, communityId?: string): Promise<any>;
+    socialTwitterPostThread(accountId: string, cookies: any[], texts: string[], proxySessionId?: string, communityId?: string): Promise<any>;
+    socialTwitterPostWithMedia(accountId: string, cookies: any[], text: string, media: Array<{
+        image_base64?: string;
+        image_url?: string;
+        video_base64?: string;
+        video_url?: string;
+    }>, proxySessionId?: string, communityId?: string): Promise<any>;
+    socialTwitterListMyTweets(accountId: string, cookies: any[], limit?: number, proxySessionId?: string): Promise<any>;
+    socialTwitterReply(accountId: string, cookies: any[], tweetUrl: string, text: string, proxySessionId?: string): Promise<any>;
+    socialTwitterLike(accountId: string, cookies: any[], tweetUrl: string, proxySessionId?: string): Promise<any>;
+    socialTwitterRetweet(accountId: string, cookies: any[], tweetUrl: string, proxySessionId?: string): Promise<any>;
+    socialTwitterFollow(accountId: string, cookies: any[], targetUser: string, proxySessionId?: string): Promise<any>;
+    socialTwitterUnfollow(accountId: string, cookies: any[], targetUser: string, proxySessionId?: string): Promise<any>;
+    socialTwitterDelete(accountId: string, cookies: any[], tweetUrl: string, proxySessionId?: string): Promise<any>;
+    socialTwitterProfile(accountId: string, cookies: any[], patch: {
+        bio?: string;
+        display_name?: string;
+        location?: string;
+        website?: string;
+    }, proxySessionId?: string): Promise<any>;
+    socialTwitterAvatar(accountId: string, cookies: any[], image: {
+        image_base64?: string;
+        image_url?: string;
+    }, proxySessionId?: string): Promise<any>;
+    socialTwitterBanner(accountId: string, cookies: any[], image: {
+        image_base64?: string;
+        image_url?: string;
+    }, proxySessionId?: string): Promise<any>;
+    socialTwitterUsername(accountId: string, cookies: any[], newUsername: string, password: string, proxySessionId?: string): Promise<any>;
+    socialTwitterBuy(country?: string, ageCategory?: string): Promise<any>;
+    /**
+     * Log a TikTok account in. Two paths:
+     *   - Cookie injection: pass `sessionid` (+ optional `tt_csrf_token`, `tt_webid_v2`).
+     *   - Form login:       pass `login` + `password` — server uses CapSolver
+     *                       to handle any captcha and harvests the cookies.
+     * Either path returns the full cookie jar for the caller to cache locally.
+     */
+    socialTiktokLogin(accountId: string, opts: {
+        sessionid?: string;
+        ttCsrfToken?: string;
+        ttWebidV2?: string;
+        extraCookies?: Array<{
+            name: string;
+            value: string;
+            domain?: string;
+            path?: string;
+        }>;
+        login?: string;
+        password?: string;
+        email?: string;
+        emailPassword?: string;
+        proxySessionId?: string;
+        country?: string;
+    }): Promise<any>;
+    socialTiktokPost(accountId: string, cookies: any[], caption: string, media: {
+        video_base64?: string;
+        video_url?: string;
+    }, opts?: {
+        privacy?: 0 | 1 | 2;
+        allow_comments?: boolean;
+        allow_duet?: boolean;
+        allow_stitch?: boolean;
+    }, proxySessionId?: string, country?: string): Promise<any>;
+    socialTiktokFollow(accountId: string, cookies: any[], targetUser: string, proxySessionId?: string, country?: string): Promise<any>;
+    socialTiktokLike(accountId: string, cookies: any[], videoUrl: string, proxySessionId?: string, country?: string): Promise<any>;
+    socialTiktokDelete(accountId: string, cookies: any[], videoUrl: string, proxySessionId?: string, country?: string): Promise<any>;
+    socialTiktokProfile(accountId: string, cookies: any[], patch: {
+        bio?: string;
+        display_name?: string;
+    }, proxySessionId?: string, country?: string): Promise<any>;
+    socialTiktokAvatar(accountId: string, cookies: any[], image: {
+        image_base64?: string;
+        image_url?: string;
+    }, proxySessionId?: string, country?: string): Promise<any>;
+    pricing(): Promise<any>;
+    health(): Promise<any>;
+    /**
+     * Generate an i402 plan from a natural-language intent.
+     * Returns the plan body (from the 402 response) or a clarification request.
+     * Auto-pays the $0.10 orchestration fee unless autoPay is disabled.
+     */
+    chat(intent: string, options: {
+        budgetUsdc: number;
+        quality?: 'fast' | 'cheap' | 'best';
+        params?: Record<string, unknown>;
+        constraints?: {
+            excludeCapabilities?: string[];
+            excludeProviders?: string[];
+            requireProviders?: string[];
+        };
+        sessionId?: string;
+        deadlineSeconds?: number;
+        approve?: boolean;
+        autoApproveUnderUsdc?: number;
+    }): Promise<any>;
+    /**
+     * Client-side executor for an i402 plan.
+     *
+     * i402 v0.1 is agent-side-execution-only: the server returns a plan and stops;
+     * this function iterates the plan's steps in topological order, signs a real
+     * x402 payment for each step (via paidRequest), calls the endpoint, resolves
+     * $STEPS.sN.output.field references into later-step inputs locally, and yields
+     * events to the caller so a CLI or agent framework can render progress.
+     *
+     * Every step's x402 payment is a real on-chain transaction signed by this
+     * client's wallet — no server-side escrow, no custodial proxy.
+     *
+     * Usage:
+     *   const plan = await ao.chat("launch a brand", { budgetUsdc: 60 })
+     *   for await (const event of ao.chatExecute(plan)) {
+     *     console.log(event.type, event)
+     *   }
+     */
+    chatExecute(plan: any, options?: {
+        stopOnFailure?: boolean;
+    }): AsyncGenerator<any, void, undefined>;
+    chatGetSession(sessionId: string): Promise<any>;
+    chatCancel(sessionId: string): Promise<any>;
+    chatListSessions(): Promise<any>;
+    chatListCapabilities(): Promise<any>;
+    chatListProviders(capability?: string): Promise<any>;
+    private requestWithHeaders;
+}
+export default Palmyr;