/** * Neynar API * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details. * * The version of the OpenAPI document: 3.137.0 * Contact: team@neynar.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { AssociateDeployment200Response } from '../models'; import type { AssociateDeploymentRequest } from '../models'; import type { BuildRequest } from '../models'; import type { CreateDeploymentRequest } from '../models'; import type { DeleteDeployment200Response } from '../models'; import type { DeleteDeploymentRequest } from '../models'; import type { DeleteRows200Response } from '../models'; import type { DeleteRowsRequest } from '../models'; import type { DeleteSecretsRequest } from '../models'; import type { DeployToVercel200Response } from '../models'; import type { DeployToVercelRequest } from '../models'; import type { ExecuteSql200Response } from '../models'; import type { ExecuteSqlRequest } from '../models'; import type { GetAccountAssociation200Response } from '../models'; import type { GetConversationMessages200Response } from '../models'; import type { GetDeploymentFile200Response } from '../models'; import type { GetDevStatus200Response } from '../models'; import type { GetTableSchema200Response } from '../models'; import type { InsertRows200Response } from '../models'; import type { InsertRowsRequest } from '../models'; import type { ListConversations200Response } from '../models'; import type { ListDeploymentFiles200Response } from '../models'; import type { ListDeployments200ResponseInner } from '../models'; import type { ListSecrets200Response } from '../models'; import type { ListTables200Response } from '../models'; import type { PromptDeploymentStreamRequest } from '../models'; import type { QueryTable200Response } from '../models'; import type { QueryTableRequest } from '../models'; import type { RecoverRequest } from '../models'; import type { StartApp200Response } from '../models'; import type { StartAppRequest } from '../models'; import type { UpdateRows200Response } from '../models'; import type { UpdateRowsRequest } from '../models'; import type { UploadImage200Response } from '../models'; import type { UploadImageUrlRequest } from '../models'; import type { UpsertSecrets200Response } from '../models'; import type { UpsertSecretsRequest } from '../models'; import type { VercelDeploymentLogs200Response } from '../models'; import type { VercelDeploymentStatus200Response } from '../models'; /** * StudioApi - axios parameter creator * @export */ export declare const StudioApiAxiosParamCreator: (configuration?: Configuration) => { /** * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Set account association * @param {AssociateDeploymentRequest} associateDeploymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `AssociateDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment) * */ associateDeployment: (associateDeploymentRequest: AssociateDeploymentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Runs Next.js build process for the generated app. If build fails, automatically calls a build-fixer agent to resolve errors. Streams build output and agent responses via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Build generated app with automatic error fixing * @param {BuildRequest} buildRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/build) * */ build: (buildRequest: BuildRequest, options?: RawAxiosRequestConfig) => Promise; /** * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Create a miniapp generator deployment * @param {CreateDeploymentRequest} createDeploymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment) * */ createDeployment: (createDeploymentRequest: CreateDeploymentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Delete deployment(s) * @param {DeleteDeploymentRequest} deleteDeploymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeleteDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment) * */ deleteDeployment: (deleteDeploymentRequest: DeleteDeploymentRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk deletes. * @summary Delete rows from table * @param {string} tableName * @param {DeleteRowsRequest} deleteRowsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeleteRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-rows) * */ deleteRows: (tableName: string, deleteRowsRequest: DeleteRowsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Deletes environment variables (secrets) from a deployment. * @summary Delete deployment secrets * @param {DeleteSecretsRequest} deleteSecretsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-secrets) * */ deleteSecrets: (deleteSecretsRequest: DeleteSecretsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Publishes the generated miniapp to Vercel via GitHub. Creates a GitHub repository, pushes code, creates a Vercel project linked to GitHub, and triggers deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Deploy miniapp to Vercel * @param {DeployToVercelRequest} deployToVercelRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeployToVercel200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-to-vercel) * */ deployToVercel: (deployToVercelRequest: DeployToVercelRequest, options?: RawAxiosRequestConfig) => Promise; /** * Executes a raw SQL query against the deployment database. Only SELECT, WITH, and EXPLAIN queries are allowed. Admin access required. * @summary Execute raw SQL query (admin only) * @param {ExecuteSqlRequest} executeSqlRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ExecuteSql200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/execute-sql) * */ executeSql: (executeSqlRequest: ExecuteSqlRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the account-association.json file from a miniapp deployment, which contains the JFS-signed domain association. Requires API key authentication. * @summary Get account association of a miniapp * @param {string} [deploymentId] Deployment ID * @param {string} [namespace] Kubernetes namespace name * @param {string} [name] Kubernetes deployment name * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetAccountAssociation200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-account-association) * */ getAccountAssociation: (deploymentId?: string, namespace?: string, name?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves all messages in a specific conversation. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get messages in a conversation * @param {string} conversationId Conversation ID * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {boolean | null} [includeDeleted] Include deleted messages in the response. Defaults to false. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetConversationMessages200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages) * */ getConversationMessages: (conversationId: string, deploymentId?: string, fid?: number | null, name?: string, namespace?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise; /** * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment info * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment) * */ getDeployment: (deploymentId?: string, fid?: number | null, name?: string, namespace?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment file contents * @param {string} filePath File path relative to gen/ * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetDeploymentFile200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file) * */ getDeploymentFile: (filePath: string, deploymentId?: string, fid?: number | null, name?: string, namespace?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get dev status of a miniapp * @param {string} [deploymentId] Deployment ID * @param {string} [namespace] Kubernetes namespace name * @param {string} [name] Kubernetes deployment name * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetDevStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-dev-status) * */ getDevStatus: (deploymentId?: string, namespace?: string, name?: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the complete schema for a table including columns, indexes, and foreign keys. * @summary Get table schema * @param {string} tableName * @param {string} deploymentId Deployment ID (UUID) * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetTableSchema200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-table-schema) * */ getTableSchema: (tableName: string, deploymentId: string, fid?: number | null, options?: RawAxiosRequestConfig) => Promise; /** * Inserts one or more rows into the specified table. Returns the inserted rows with generated values. * @summary Insert rows into table * @param {string} tableName * @param {InsertRowsRequest} insertRowsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `InsertRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/insert-rows) * */ insertRows: (tableName: string, insertRowsRequest: InsertRowsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Lists all conversations for a specific deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List conversations for a deployment * @param {string} [deploymentId] Deployment ID (UUID). If provided, filters conversations to this deployment only. * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations. * @param {string} [name] Kubernetes deployment name. If provided, filters conversations to this deployment only. * @param {boolean | null} [includeDeleted] Include deleted conversations in the response. Defaults to false. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListConversations200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations) * */ listConversations: (deploymentId?: string, fid?: number | null, name?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise; /** * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployment files * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {string} [directory] Directory path relative to gen/ (defaults to root) * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeploymentFiles200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files) * */ listDeploymentFiles: (deploymentId?: string, fid?: number | null, name?: string, namespace?: string, directory?: string, options?: RawAxiosRequestConfig) => Promise; /** * Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployments * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments. * @param {number} [limit] Maximum number of deployments to return. Defaults to 50, max 1000. (Default: 50, Maximum: 1000) * @param {number | null} [offset] Number of deployments to skip for pagination. Defaults to 0. * @param {boolean | null} [includeDeleted] Include deleted deployments in the response. Defaults to false. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise>} A promise that resolves to a `Array` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments) * */ listDeployments: (fid?: number | null, limit?: number, offset?: number | null, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves all secrets for a deployment. * @summary List deployment secrets * @param {string} deploymentId Deployment ID to list secrets for * @param {string} [key] Optional filter by environment variable name * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-secrets) * */ listSecrets: (deploymentId: string, key?: string, options?: RawAxiosRequestConfig) => Promise; /** * Lists all tables and views in the deployment database, excluding system tables. * @summary List all tables in deployment database * @param {string} deploymentId Deployment ID (UUID) * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListTables200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-tables) * */ listTables: (deploymentId: string, fid?: number | null, options?: RawAxiosRequestConfig) => Promise; /** * Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Prompt a deployment with streaming response * @param {PromptDeploymentStreamRequest} promptDeploymentStreamRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream) * */ promptDeploymentStream: (promptDeploymentStreamRequest: PromptDeploymentStreamRequest, options?: RawAxiosRequestConfig) => Promise; /** * Query data from a table with pagination and sorting. * @summary Query table data * @param {QueryTableRequest} queryTableRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `QueryTable200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/query-table) * */ queryTable: (queryTableRequest: QueryTableRequest, options?: RawAxiosRequestConfig) => Promise; /** * Attempts to recover a broken dev server. Phase 1: reads dev server error logs and sends them to an AI agent for fixing, then waits for HMR to auto-rebuild. Phase 2: if HMR fails, falls back to a full npm build with AI retry loop. Streams progress events via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Recover dev server with two-phase strategy * @param {RecoverRequest} recoverRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/recover) * */ recover: (recoverRequest: RecoverRequest, options?: RawAxiosRequestConfig) => Promise; /** * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Start generated miniapp * @param {StartAppRequest} startAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app) * */ startApp: (startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig) => Promise; /** * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Stop generated miniapp * @param {StartAppRequest} startAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app) * */ stopApp: (startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig) => Promise; /** * Updates rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk updates. * @summary Update rows in table * @param {string} tableName * @param {UpdateRowsRequest} updateRowsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpdateRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-rows) * */ updateRows: (tableName: string, updateRowsRequest: UpdateRowsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image to deployment * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image) * */ uploadImage: (options?: RawAxiosRequestConfig) => Promise; /** * Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image from URL to deployment * @param {UploadImageUrlRequest} uploadImageUrlRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url) * */ uploadImageUrl: (uploadImageUrlRequest: UploadImageUrlRequest, options?: RawAxiosRequestConfig) => Promise; /** * Upsert secrets for a deployment. * @summary Upsert deployment secrets * @param {UpsertSecretsRequest} upsertSecretsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upsert-secrets) * */ upsertSecrets: (upsertSecretsRequest: UpsertSecretsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment build logs * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user * @param {string} [namespace] K8s Namespace name * @param {string} [name] Deployment name used to identify the Vercel project. Required if deployment_id not provided. * @param {number} [limit] Maximum number of log events to return. Defaults to 100. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `VercelDeploymentLogs200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-logs) * */ vercelDeploymentLogs: (deploymentId?: string, fid?: number | null, namespace?: string, name?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment status * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [namespace] K8s Namespace name * @param {string} [name] Deployment name used to identify the Vercel project. Required if deployment_id not provided. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `VercelDeploymentStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-status) * */ vercelDeploymentStatus: (deploymentId?: string, fid?: number | null, namespace?: string, name?: string, options?: RawAxiosRequestConfig) => Promise; }; /** * StudioApi - functional programming interface * @export */ export declare const StudioApiFp: (configuration?: Configuration) => { /** * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Set account association * @param {AssociateDeploymentRequest} associateDeploymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `AssociateDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment) * */ associateDeployment(associateDeploymentRequest: AssociateDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Runs Next.js build process for the generated app. If build fails, automatically calls a build-fixer agent to resolve errors. Streams build output and agent responses via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Build generated app with automatic error fixing * @param {BuildRequest} buildRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/build) * */ build(buildRequest: BuildRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Create a miniapp generator deployment * @param {CreateDeploymentRequest} createDeploymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment) * */ createDeployment(createDeploymentRequest: CreateDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Delete deployment(s) * @param {DeleteDeploymentRequest} deleteDeploymentRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeleteDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment) * */ deleteDeployment(deleteDeploymentRequest: DeleteDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk deletes. * @summary Delete rows from table * @param {string} tableName * @param {DeleteRowsRequest} deleteRowsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeleteRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-rows) * */ deleteRows(tableName: string, deleteRowsRequest: DeleteRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Deletes environment variables (secrets) from a deployment. * @summary Delete deployment secrets * @param {DeleteSecretsRequest} deleteSecretsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-secrets) * */ deleteSecrets(deleteSecretsRequest: DeleteSecretsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Publishes the generated miniapp to Vercel via GitHub. Creates a GitHub repository, pushes code, creates a Vercel project linked to GitHub, and triggers deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Deploy miniapp to Vercel * @param {DeployToVercelRequest} deployToVercelRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeployToVercel200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-to-vercel) * */ deployToVercel(deployToVercelRequest: DeployToVercelRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Executes a raw SQL query against the deployment database. Only SELECT, WITH, and EXPLAIN queries are allowed. Admin access required. * @summary Execute raw SQL query (admin only) * @param {ExecuteSqlRequest} executeSqlRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ExecuteSql200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/execute-sql) * */ executeSql(executeSqlRequest: ExecuteSqlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the account-association.json file from a miniapp deployment, which contains the JFS-signed domain association. Requires API key authentication. * @summary Get account association of a miniapp * @param {string} [deploymentId] Deployment ID * @param {string} [namespace] Kubernetes namespace name * @param {string} [name] Kubernetes deployment name * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetAccountAssociation200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-account-association) * */ getAccountAssociation(deploymentId?: string, namespace?: string, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves all messages in a specific conversation. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get messages in a conversation * @param {string} conversationId Conversation ID * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {boolean | null} [includeDeleted] Include deleted messages in the response. Defaults to false. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetConversationMessages200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages) * */ getConversationMessages(conversationId: string, deploymentId?: string, fid?: number | null, name?: string, namespace?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment info * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment) * */ getDeployment(deploymentId?: string, fid?: number | null, name?: string, namespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment file contents * @param {string} filePath File path relative to gen/ * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetDeploymentFile200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file) * */ getDeploymentFile(filePath: string, deploymentId?: string, fid?: number | null, name?: string, namespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get dev status of a miniapp * @param {string} [deploymentId] Deployment ID * @param {string} [namespace] Kubernetes namespace name * @param {string} [name] Kubernetes deployment name * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetDevStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-dev-status) * */ getDevStatus(deploymentId?: string, namespace?: string, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the complete schema for a table including columns, indexes, and foreign keys. * @summary Get table schema * @param {string} tableName * @param {string} deploymentId Deployment ID (UUID) * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetTableSchema200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-table-schema) * */ getTableSchema(tableName: string, deploymentId: string, fid?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Inserts one or more rows into the specified table. Returns the inserted rows with generated values. * @summary Insert rows into table * @param {string} tableName * @param {InsertRowsRequest} insertRowsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `InsertRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/insert-rows) * */ insertRows(tableName: string, insertRowsRequest: InsertRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all conversations for a specific deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List conversations for a deployment * @param {string} [deploymentId] Deployment ID (UUID). If provided, filters conversations to this deployment only. * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations. * @param {string} [name] Kubernetes deployment name. If provided, filters conversations to this deployment only. * @param {boolean | null} [includeDeleted] Include deleted conversations in the response. Defaults to false. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListConversations200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations) * */ listConversations(deploymentId?: string, fid?: number | null, name?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployment files * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [name] Kubernetes deployment name. Required if deployment_id not provided. * @param {string} [namespace] Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * @param {string} [directory] Directory path relative to gen/ (defaults to root) * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeploymentFiles200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files) * */ listDeploymentFiles(deploymentId?: string, fid?: number | null, name?: string, namespace?: string, directory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployments * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments. * @param {number} [limit] Maximum number of deployments to return. Defaults to 50, max 1000. (Default: 50, Maximum: 1000) * @param {number | null} [offset] Number of deployments to skip for pagination. Defaults to 0. * @param {boolean | null} [includeDeleted] Include deleted deployments in the response. Defaults to false. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise>} A promise that resolves to a `Array` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments) * */ listDeployments(fid?: number | null, limit?: number, offset?: number | null, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Retrieves all secrets for a deployment. * @summary List deployment secrets * @param {string} deploymentId Deployment ID to list secrets for * @param {string} [key] Optional filter by environment variable name * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-secrets) * */ listSecrets(deploymentId: string, key?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists all tables and views in the deployment database, excluding system tables. * @summary List all tables in deployment database * @param {string} deploymentId Deployment ID (UUID) * @param {number | null} [fid] Farcaster ID of the user. Required for non-admin users. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListTables200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-tables) * */ listTables(deploymentId: string, fid?: number | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Prompt a deployment with streaming response * @param {PromptDeploymentStreamRequest} promptDeploymentStreamRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream) * */ promptDeploymentStream(promptDeploymentStreamRequest: PromptDeploymentStreamRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Query data from a table with pagination and sorting. * @summary Query table data * @param {QueryTableRequest} queryTableRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `QueryTable200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/query-table) * */ queryTable(queryTableRequest: QueryTableRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Attempts to recover a broken dev server. Phase 1: reads dev server error logs and sends them to an AI agent for fixing, then waits for HMR to auto-rebuild. Phase 2: if HMR fails, falls back to a full npm build with AI retry loop. Streams progress events via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Recover dev server with two-phase strategy * @param {RecoverRequest} recoverRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/recover) * */ recover(recoverRequest: RecoverRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Start generated miniapp * @param {StartAppRequest} startAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app) * */ startApp(startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Stop generated miniapp * @param {StartAppRequest} startAppRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app) * */ stopApp(startAppRequest: StartAppRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Updates rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk updates. * @summary Update rows in table * @param {string} tableName * @param {UpdateRowsRequest} updateRowsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpdateRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-rows) * */ updateRows(tableName: string, updateRowsRequest: UpdateRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image to deployment * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image) * */ uploadImage(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image from URL to deployment * @param {UploadImageUrlRequest} uploadImageUrlRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url) * */ uploadImageUrl(uploadImageUrlRequest: UploadImageUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Upsert secrets for a deployment. * @summary Upsert deployment secrets * @param {UpsertSecretsRequest} upsertSecretsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upsert-secrets) * */ upsertSecrets(upsertSecretsRequest: UpsertSecretsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment build logs * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user * @param {string} [namespace] K8s Namespace name * @param {string} [name] Deployment name used to identify the Vercel project. Required if deployment_id not provided. * @param {number} [limit] Maximum number of log events to return. Defaults to 100. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `VercelDeploymentLogs200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-logs) * */ vercelDeploymentLogs(deploymentId?: string, fid?: number | null, namespace?: string, name?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment status * @param {string} [deploymentId] Deployment ID (UUID). Required if name not provided. * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided * @param {string} [namespace] K8s Namespace name * @param {string} [name] Deployment name used to identify the Vercel project. Required if deployment_id not provided. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `VercelDeploymentStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-status) * */ vercelDeploymentStatus(deploymentId?: string, fid?: number | null, namespace?: string, name?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * StudioApi - factory interface * @export */ export declare const StudioApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Set account association * @param {StudioApiAssociateDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `AssociateDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment) * */ associateDeployment(requestParameters: StudioApiAssociateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Runs Next.js build process for the generated app. If build fails, automatically calls a build-fixer agent to resolve errors. Streams build output and agent responses via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Build generated app with automatic error fixing * @param {StudioApiBuildRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/build) * */ build(requestParameters: StudioApiBuildRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Create a miniapp generator deployment * @param {StudioApiCreateDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment) * */ createDeployment(requestParameters: StudioApiCreateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Delete deployment(s) * @param {StudioApiDeleteDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeleteDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment) * */ deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk deletes. * @summary Delete rows from table * @param {StudioApiDeleteRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeleteRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-rows) * */ deleteRows(requestParameters: StudioApiDeleteRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes environment variables (secrets) from a deployment. * @summary Delete deployment secrets * @param {StudioApiDeleteSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-secrets) * */ deleteSecrets(requestParameters: StudioApiDeleteSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Publishes the generated miniapp to Vercel via GitHub. Creates a GitHub repository, pushes code, creates a Vercel project linked to GitHub, and triggers deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Deploy miniapp to Vercel * @param {StudioApiDeployToVercelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `DeployToVercel200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-to-vercel) * */ deployToVercel(requestParameters: StudioApiDeployToVercelRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Executes a raw SQL query against the deployment database. Only SELECT, WITH, and EXPLAIN queries are allowed. Admin access required. * @summary Execute raw SQL query (admin only) * @param {StudioApiExecuteSqlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ExecuteSql200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/execute-sql) * */ executeSql(requestParameters: StudioApiExecuteSqlRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the account-association.json file from a miniapp deployment, which contains the JFS-signed domain association. Requires API key authentication. * @summary Get account association of a miniapp * @param {StudioApiGetAccountAssociationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetAccountAssociation200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-account-association) * */ getAccountAssociation(requestParameters?: StudioApiGetAccountAssociationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves all messages in a specific conversation. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get messages in a conversation * @param {StudioApiGetConversationMessagesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetConversationMessages200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages) * */ getConversationMessages(requestParameters: StudioApiGetConversationMessagesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment info * @param {StudioApiGetDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment) * */ getDeployment(requestParameters?: StudioApiGetDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment file contents * @param {StudioApiGetDeploymentFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetDeploymentFile200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file) * */ getDeploymentFile(requestParameters: StudioApiGetDeploymentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get dev status of a miniapp * @param {StudioApiGetDevStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetDevStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-dev-status) * */ getDevStatus(requestParameters?: StudioApiGetDevStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the complete schema for a table including columns, indexes, and foreign keys. * @summary Get table schema * @param {StudioApiGetTableSchemaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `GetTableSchema200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-table-schema) * */ getTableSchema(requestParameters: StudioApiGetTableSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Inserts one or more rows into the specified table. Returns the inserted rows with generated values. * @summary Insert rows into table * @param {StudioApiInsertRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `InsertRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/insert-rows) * */ insertRows(requestParameters: StudioApiInsertRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all conversations for a specific deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List conversations for a deployment * @param {StudioApiListConversationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListConversations200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations) * */ listConversations(requestParameters?: StudioApiListConversationsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployment files * @param {StudioApiListDeploymentFilesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListDeploymentFiles200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files) * */ listDeploymentFiles(requestParameters?: StudioApiListDeploymentFilesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployments * @param {StudioApiListDeploymentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise>} A promise that resolves to a `Array` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments) * */ listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves all secrets for a deployment. * @summary List deployment secrets * @param {StudioApiListSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-secrets) * */ listSecrets(requestParameters: StudioApiListSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all tables and views in the deployment database, excluding system tables. * @summary List all tables in deployment database * @param {StudioApiListTablesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `ListTables200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-tables) * */ listTables(requestParameters: StudioApiListTablesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Prompt a deployment with streaming response * @param {StudioApiPromptDeploymentStreamRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream) * */ promptDeploymentStream(requestParameters: StudioApiPromptDeploymentStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Query data from a table with pagination and sorting. * @summary Query table data * @param {StudioApiQueryTableRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `QueryTable200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/query-table) * */ queryTable(requestParameters: StudioApiQueryTableRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Attempts to recover a broken dev server. Phase 1: reads dev server error logs and sends them to an AI agent for fixing, then waits for HMR to auto-rebuild. Phase 2: if HMR fails, falls back to a full npm build with AI retry loop. Streams progress events via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Recover dev server with two-phase strategy * @param {StudioApiRecoverRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/recover) * */ recover(requestParameters: StudioApiRecoverRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Start generated miniapp * @param {StudioApiStartAppRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app) * */ startApp(requestParameters: StudioApiStartAppRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Stop generated miniapp * @param {StudioApiStopAppRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app) * */ stopApp(requestParameters: StudioApiStopAppRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk updates. * @summary Update rows in table * @param {StudioApiUpdateRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpdateRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-rows) * */ updateRows(requestParameters: StudioApiUpdateRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image to deployment * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image) * */ uploadImage(options?: RawAxiosRequestConfig): AxiosPromise; /** * Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image from URL to deployment * @param {StudioApiUploadImageUrlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url) * */ uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Upsert secrets for a deployment. * @summary Upsert deployment secrets * @param {StudioApiUpsertSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upsert-secrets) * */ upsertSecrets(requestParameters: StudioApiUpsertSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment build logs * @param {StudioApiVercelDeploymentLogsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `VercelDeploymentLogs200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-logs) * */ vercelDeploymentLogs(requestParameters?: StudioApiVercelDeploymentLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment status * @param {StudioApiVercelDeploymentStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @returns {Promise} A promise that resolves to a `VercelDeploymentStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-status) * */ vercelDeploymentStatus(requestParameters?: StudioApiVercelDeploymentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * StudioApi - interface * @export * @interface StudioApi */ export interface StudioApiInterface { /** * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Set account association * @param {StudioApiAssociateDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `AssociateDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment) * */ associateDeployment(requestParameters: StudioApiAssociateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Runs Next.js build process for the generated app. If build fails, automatically calls a build-fixer agent to resolve errors. Streams build output and agent responses via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Build generated app with automatic error fixing * @param {StudioApiBuildRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/build) * */ build(requestParameters: StudioApiBuildRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Create a miniapp generator deployment * @param {StudioApiCreateDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment) * */ createDeployment(requestParameters: StudioApiCreateDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Delete deployment(s) * @param {StudioApiDeleteDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `DeleteDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment) * */ deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk deletes. * @summary Delete rows from table * @param {StudioApiDeleteRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `DeleteRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-rows) * */ deleteRows(requestParameters: StudioApiDeleteRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Deletes environment variables (secrets) from a deployment. * @summary Delete deployment secrets * @param {StudioApiDeleteSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-secrets) * */ deleteSecrets(requestParameters: StudioApiDeleteSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Publishes the generated miniapp to Vercel via GitHub. Creates a GitHub repository, pushes code, creates a Vercel project linked to GitHub, and triggers deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Deploy miniapp to Vercel * @param {StudioApiDeployToVercelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `DeployToVercel200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-to-vercel) * */ deployToVercel(requestParameters: StudioApiDeployToVercelRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Executes a raw SQL query against the deployment database. Only SELECT, WITH, and EXPLAIN queries are allowed. Admin access required. * @summary Execute raw SQL query (admin only) * @param {StudioApiExecuteSqlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `ExecuteSql200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/execute-sql) * */ executeSql(requestParameters: StudioApiExecuteSqlRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the account-association.json file from a miniapp deployment, which contains the JFS-signed domain association. Requires API key authentication. * @summary Get account association of a miniapp * @param {StudioApiGetAccountAssociationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `GetAccountAssociation200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-account-association) * */ getAccountAssociation(requestParameters?: StudioApiGetAccountAssociationRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves all messages in a specific conversation. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get messages in a conversation * @param {StudioApiGetConversationMessagesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `GetConversationMessages200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages) * */ getConversationMessages(requestParameters: StudioApiGetConversationMessagesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment info * @param {StudioApiGetDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment) * */ getDeployment(requestParameters?: StudioApiGetDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment file contents * @param {StudioApiGetDeploymentFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `GetDeploymentFile200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file) * */ getDeploymentFile(requestParameters: StudioApiGetDeploymentFileRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get dev status of a miniapp * @param {StudioApiGetDevStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `GetDevStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-dev-status) * */ getDevStatus(requestParameters?: StudioApiGetDevStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the complete schema for a table including columns, indexes, and foreign keys. * @summary Get table schema * @param {StudioApiGetTableSchemaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `GetTableSchema200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-table-schema) * */ getTableSchema(requestParameters: StudioApiGetTableSchemaRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Inserts one or more rows into the specified table. Returns the inserted rows with generated values. * @summary Insert rows into table * @param {StudioApiInsertRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `InsertRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/insert-rows) * */ insertRows(requestParameters: StudioApiInsertRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all conversations for a specific deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List conversations for a deployment * @param {StudioApiListConversationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `ListConversations200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations) * */ listConversations(requestParameters?: StudioApiListConversationsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployment files * @param {StudioApiListDeploymentFilesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `ListDeploymentFiles200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files) * */ listDeploymentFiles(requestParameters?: StudioApiListDeploymentFilesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployments * @param {StudioApiListDeploymentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise>} A promise that resolves to a `Array` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments) * */ listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): AxiosPromise>; /** * Retrieves all secrets for a deployment. * @summary List deployment secrets * @param {StudioApiListSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `ListSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-secrets) * */ listSecrets(requestParameters: StudioApiListSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Lists all tables and views in the deployment database, excluding system tables. * @summary List all tables in deployment database * @param {StudioApiListTablesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `ListTables200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-tables) * */ listTables(requestParameters: StudioApiListTablesRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Prompt a deployment with streaming response * @param {StudioApiPromptDeploymentStreamRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream) * */ promptDeploymentStream(requestParameters: StudioApiPromptDeploymentStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Query data from a table with pagination and sorting. * @summary Query table data * @param {StudioApiQueryTableRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `QueryTable200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/query-table) * */ queryTable(requestParameters: StudioApiQueryTableRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Attempts to recover a broken dev server. Phase 1: reads dev server error logs and sends them to an AI agent for fixing, then waits for HMR to auto-rebuild. Phase 2: if HMR fails, falls back to a full npm build with AI retry loop. Streams progress events via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Recover dev server with two-phase strategy * @param {StudioApiRecoverRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/recover) * */ recover(requestParameters: StudioApiRecoverRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Start generated miniapp * @param {StudioApiStartAppRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app) * */ startApp(requestParameters: StudioApiStartAppRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Stop generated miniapp * @param {StudioApiStopAppRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app) * */ stopApp(requestParameters: StudioApiStopAppRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Updates rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk updates. * @summary Update rows in table * @param {StudioApiUpdateRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `UpdateRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-rows) * */ updateRows(requestParameters: StudioApiUpdateRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image to deployment * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image) * */ uploadImage(options?: RawAxiosRequestConfig): AxiosPromise; /** * Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image from URL to deployment * @param {StudioApiUploadImageUrlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url) * */ uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Upsert secrets for a deployment. * @summary Upsert deployment secrets * @param {StudioApiUpsertSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upsert-secrets) * */ upsertSecrets(requestParameters: StudioApiUpsertSecretsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment build logs * @param {StudioApiVercelDeploymentLogsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `VercelDeploymentLogs200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-logs) * */ vercelDeploymentLogs(requestParameters?: StudioApiVercelDeploymentLogsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment status * @param {StudioApiVercelDeploymentStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApiInterface * @returns {Promise} A promise that resolves to a `VercelDeploymentStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-status) * */ vercelDeploymentStatus(requestParameters?: StudioApiVercelDeploymentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise; } /** * Request parameters for associateDeployment operation in StudioApi. * @export * @interface StudioApiAssociateDeploymentRequest */ export interface StudioApiAssociateDeploymentRequest { /** * * * * * @type {AssociateDeploymentRequest} * @memberof StudioApiAssociateDeployment */ readonly associateDeploymentRequest: AssociateDeploymentRequest; } /** * Request parameters for build operation in StudioApi. * @export * @interface StudioApiBuildRequest */ export interface StudioApiBuildRequest { /** * * * * * @type {BuildRequest} * @memberof StudioApiBuild */ readonly buildRequest: BuildRequest; } /** * Request parameters for createDeployment operation in StudioApi. * @export * @interface StudioApiCreateDeploymentRequest */ export interface StudioApiCreateDeploymentRequest { /** * * * * * @type {CreateDeploymentRequest} * @memberof StudioApiCreateDeployment */ readonly createDeploymentRequest: CreateDeploymentRequest; } /** * Request parameters for deleteDeployment operation in StudioApi. * @export * @interface StudioApiDeleteDeploymentRequest */ export interface StudioApiDeleteDeploymentRequest { /** * * * * * @type {DeleteDeploymentRequest} * @memberof StudioApiDeleteDeployment */ readonly deleteDeploymentRequest: DeleteDeploymentRequest; } /** * Request parameters for deleteRows operation in StudioApi. * @export * @interface StudioApiDeleteRowsRequest */ export interface StudioApiDeleteRowsRequest { /** * * * * * @type {string} * @memberof StudioApiDeleteRows */ readonly tableName: string; /** * * * * * @type {DeleteRowsRequest} * @memberof StudioApiDeleteRows */ readonly deleteRowsRequest: DeleteRowsRequest; } /** * Request parameters for deleteSecrets operation in StudioApi. * @export * @interface StudioApiDeleteSecretsRequest */ export interface StudioApiDeleteSecretsRequest { /** * * * * * @type {DeleteSecretsRequest} * @memberof StudioApiDeleteSecrets */ readonly deleteSecretsRequest: DeleteSecretsRequest; } /** * Request parameters for deployToVercel operation in StudioApi. * @export * @interface StudioApiDeployToVercelRequest */ export interface StudioApiDeployToVercelRequest { /** * * * * * @type {DeployToVercelRequest} * @memberof StudioApiDeployToVercel */ readonly deployToVercelRequest: DeployToVercelRequest; } /** * Request parameters for executeSql operation in StudioApi. * @export * @interface StudioApiExecuteSqlRequest */ export interface StudioApiExecuteSqlRequest { /** * * * * * @type {ExecuteSqlRequest} * @memberof StudioApiExecuteSql */ readonly executeSqlRequest: ExecuteSqlRequest; } /** * Request parameters for getAccountAssociation operation in StudioApi. * @export * @interface StudioApiGetAccountAssociationRequest */ export interface StudioApiGetAccountAssociationRequest { /** * Deployment ID * * * * @type {string} * @memberof StudioApiGetAccountAssociation */ readonly deploymentId?: string; /** * Kubernetes namespace name * * * * @type {string} * @memberof StudioApiGetAccountAssociation */ readonly namespace?: string; /** * Kubernetes deployment name * * * * @type {string} * @memberof StudioApiGetAccountAssociation */ readonly name?: string; } /** * Request parameters for getConversationMessages operation in StudioApi. * @export * @interface StudioApiGetConversationMessagesRequest */ export interface StudioApiGetConversationMessagesRequest { /** * Conversation ID * * * * @type {string} * @memberof StudioApiGetConversationMessages */ readonly conversationId: string; /** * Deployment ID (UUID). Required if name not provided. * * * * @type {string} * @memberof StudioApiGetConversationMessages */ readonly deploymentId?: string; /** * Farcaster ID of the user; if not provided, namespace must be provided * * * * @type {number} * @memberof StudioApiGetConversationMessages */ readonly fid?: number | null; /** * Kubernetes deployment name. Required if deployment_id not provided. * * * * @type {string} * @memberof StudioApiGetConversationMessages */ readonly name?: string; /** * Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * * * * @type {string} * @memberof StudioApiGetConversationMessages */ readonly namespace?: string; /** * Include deleted messages in the response. Defaults to false. * * * * @type {boolean} * @memberof StudioApiGetConversationMessages */ readonly includeDeleted?: boolean | null; } /** * Request parameters for getDeployment operation in StudioApi. * @export * @interface StudioApiGetDeploymentRequest */ export interface StudioApiGetDeploymentRequest { /** * Deployment ID (UUID). Required if name not provided. * * * * @type {string} * @memberof StudioApiGetDeployment */ readonly deploymentId?: string; /** * Farcaster ID of the user; if not provided, namespace must be provided * * * * @type {number} * @memberof StudioApiGetDeployment */ readonly fid?: number | null; /** * Kubernetes deployment name. Required if deployment_id not provided. * * * * @type {string} * @memberof StudioApiGetDeployment */ readonly name?: string; /** * Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * * * * @type {string} * @memberof StudioApiGetDeployment */ readonly namespace?: string; } /** * Request parameters for getDeploymentFile operation in StudioApi. * @export * @interface StudioApiGetDeploymentFileRequest */ export interface StudioApiGetDeploymentFileRequest { /** * File path relative to gen/ * * * * @type {string} * @memberof StudioApiGetDeploymentFile */ readonly filePath: string; /** * Deployment ID (UUID). Required if name not provided. * * * * @type {string} * @memberof StudioApiGetDeploymentFile */ readonly deploymentId?: string; /** * Farcaster ID of the user; if not provided, namespace must be provided * * * * @type {number} * @memberof StudioApiGetDeploymentFile */ readonly fid?: number | null; /** * Kubernetes deployment name. Required if deployment_id not provided. * * * * @type {string} * @memberof StudioApiGetDeploymentFile */ readonly name?: string; /** * Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * * * * @type {string} * @memberof StudioApiGetDeploymentFile */ readonly namespace?: string; } /** * Request parameters for getDevStatus operation in StudioApi. * @export * @interface StudioApiGetDevStatusRequest */ export interface StudioApiGetDevStatusRequest { /** * Deployment ID * * * * @type {string} * @memberof StudioApiGetDevStatus */ readonly deploymentId?: string; /** * Kubernetes namespace name * * * * @type {string} * @memberof StudioApiGetDevStatus */ readonly namespace?: string; /** * Kubernetes deployment name * * * * @type {string} * @memberof StudioApiGetDevStatus */ readonly name?: string; } /** * Request parameters for getTableSchema operation in StudioApi. * @export * @interface StudioApiGetTableSchemaRequest */ export interface StudioApiGetTableSchemaRequest { /** * * * * * @type {string} * @memberof StudioApiGetTableSchema */ readonly tableName: string; /** * Deployment ID (UUID) * * * * @type {string} * @memberof StudioApiGetTableSchema */ readonly deploymentId: string; /** * Farcaster ID of the user. Required for non-admin users. * * * * @type {number} * @memberof StudioApiGetTableSchema */ readonly fid?: number | null; } /** * Request parameters for insertRows operation in StudioApi. * @export * @interface StudioApiInsertRowsRequest */ export interface StudioApiInsertRowsRequest { /** * * * * * @type {string} * @memberof StudioApiInsertRows */ readonly tableName: string; /** * * * * * @type {InsertRowsRequest} * @memberof StudioApiInsertRows */ readonly insertRowsRequest: InsertRowsRequest; } /** * Request parameters for listConversations operation in StudioApi. * @export * @interface StudioApiListConversationsRequest */ export interface StudioApiListConversationsRequest { /** * Deployment ID (UUID). If provided, filters conversations to this deployment only. * * * * @type {string} * @memberof StudioApiListConversations */ readonly deploymentId?: string; /** * Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations. * * * * @type {number} * @memberof StudioApiListConversations */ readonly fid?: number | null; /** * Kubernetes deployment name. If provided, filters conversations to this deployment only. * * * * @type {string} * @memberof StudioApiListConversations */ readonly name?: string; /** * Include deleted conversations in the response. Defaults to false. * * * * @type {boolean} * @memberof StudioApiListConversations */ readonly includeDeleted?: boolean | null; } /** * Request parameters for listDeploymentFiles operation in StudioApi. * @export * @interface StudioApiListDeploymentFilesRequest */ export interface StudioApiListDeploymentFilesRequest { /** * Deployment ID (UUID). Required if name not provided. * * * * @type {string} * @memberof StudioApiListDeploymentFiles */ readonly deploymentId?: string; /** * Farcaster ID of the user; if not provided, namespace must be provided * * * * @type {number} * @memberof StudioApiListDeploymentFiles */ readonly fid?: number | null; /** * Kubernetes deployment name. Required if deployment_id not provided. * * * * @type {string} * @memberof StudioApiListDeploymentFiles */ readonly name?: string; /** * Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID. * * * * @type {string} * @memberof StudioApiListDeploymentFiles */ readonly namespace?: string; /** * Directory path relative to gen/ (defaults to root) * * * * @type {string} * @memberof StudioApiListDeploymentFiles */ readonly directory?: string; } /** * Request parameters for listDeployments operation in StudioApi. * @export * @interface StudioApiListDeploymentsRequest */ export interface StudioApiListDeploymentsRequest { /** * Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all deployments. * * * * @type {number} * @memberof StudioApiListDeployments */ readonly fid?: number | null; /** * Maximum number of deployments to return. Defaults to 50, max 1000. (Default: 50, Maximum: 1000) * * * * @type {number} * @memberof StudioApiListDeployments */ readonly limit?: number; /** * Number of deployments to skip for pagination. Defaults to 0. * * * * @type {number} * @memberof StudioApiListDeployments */ readonly offset?: number | null; /** * Include deleted deployments in the response. Defaults to false. * * * * @type {boolean} * @memberof StudioApiListDeployments */ readonly includeDeleted?: boolean | null; } /** * Request parameters for listSecrets operation in StudioApi. * @export * @interface StudioApiListSecretsRequest */ export interface StudioApiListSecretsRequest { /** * Deployment ID to list secrets for * * * * @type {string} * @memberof StudioApiListSecrets */ readonly deploymentId: string; /** * Optional filter by environment variable name * * * * @type {string} * @memberof StudioApiListSecrets */ readonly key?: string; } /** * Request parameters for listTables operation in StudioApi. * @export * @interface StudioApiListTablesRequest */ export interface StudioApiListTablesRequest { /** * Deployment ID (UUID) * * * * @type {string} * @memberof StudioApiListTables */ readonly deploymentId: string; /** * Farcaster ID of the user. Required for non-admin users. * * * * @type {number} * @memberof StudioApiListTables */ readonly fid?: number | null; } /** * Request parameters for promptDeploymentStream operation in StudioApi. * @export * @interface StudioApiPromptDeploymentStreamRequest */ export interface StudioApiPromptDeploymentStreamRequest { /** * * * * * @type {PromptDeploymentStreamRequest} * @memberof StudioApiPromptDeploymentStream */ readonly promptDeploymentStreamRequest: PromptDeploymentStreamRequest; } /** * Request parameters for queryTable operation in StudioApi. * @export * @interface StudioApiQueryTableRequest */ export interface StudioApiQueryTableRequest { /** * * * * * @type {QueryTableRequest} * @memberof StudioApiQueryTable */ readonly queryTableRequest: QueryTableRequest; } /** * Request parameters for recover operation in StudioApi. * @export * @interface StudioApiRecoverRequest */ export interface StudioApiRecoverRequest { /** * * * * * @type {RecoverRequest} * @memberof StudioApiRecover */ readonly recoverRequest: RecoverRequest; } /** * Request parameters for startApp operation in StudioApi. * @export * @interface StudioApiStartAppRequest */ export interface StudioApiStartAppRequest { /** * * * * * @type {StartAppRequest} * @memberof StudioApiStartApp */ readonly startAppRequest: StartAppRequest; } /** * Request parameters for stopApp operation in StudioApi. * @export * @interface StudioApiStopAppRequest */ export interface StudioApiStopAppRequest { /** * * * * * @type {StartAppRequest} * @memberof StudioApiStopApp */ readonly startAppRequest: StartAppRequest; } /** * Request parameters for updateRows operation in StudioApi. * @export * @interface StudioApiUpdateRowsRequest */ export interface StudioApiUpdateRowsRequest { /** * * * * * @type {string} * @memberof StudioApiUpdateRows */ readonly tableName: string; /** * * * * * @type {UpdateRowsRequest} * @memberof StudioApiUpdateRows */ readonly updateRowsRequest: UpdateRowsRequest; } /** * Request parameters for uploadImageUrl operation in StudioApi. * @export * @interface StudioApiUploadImageUrlRequest */ export interface StudioApiUploadImageUrlRequest { /** * * * * * @type {UploadImageUrlRequest} * @memberof StudioApiUploadImageUrl */ readonly uploadImageUrlRequest: UploadImageUrlRequest; } /** * Request parameters for upsertSecrets operation in StudioApi. * @export * @interface StudioApiUpsertSecretsRequest */ export interface StudioApiUpsertSecretsRequest { /** * * * * * @type {UpsertSecretsRequest} * @memberof StudioApiUpsertSecrets */ readonly upsertSecretsRequest: UpsertSecretsRequest; } /** * Request parameters for vercelDeploymentLogs operation in StudioApi. * @export * @interface StudioApiVercelDeploymentLogsRequest */ export interface StudioApiVercelDeploymentLogsRequest { /** * Deployment ID (UUID). Required if name not provided. * * * * @type {string} * @memberof StudioApiVercelDeploymentLogs */ readonly deploymentId?: string; /** * Farcaster ID of the user * * * * @type {number} * @memberof StudioApiVercelDeploymentLogs */ readonly fid?: number | null; /** * K8s Namespace name * * * * @type {string} * @memberof StudioApiVercelDeploymentLogs */ readonly namespace?: string; /** * Deployment name used to identify the Vercel project. Required if deployment_id not provided. * * * * @type {string} * @memberof StudioApiVercelDeploymentLogs */ readonly name?: string; /** * Maximum number of log events to return. Defaults to 100. * * * * @type {number} * @memberof StudioApiVercelDeploymentLogs */ readonly limit?: number; } /** * Request parameters for vercelDeploymentStatus operation in StudioApi. * @export * @interface StudioApiVercelDeploymentStatusRequest */ export interface StudioApiVercelDeploymentStatusRequest { /** * Deployment ID (UUID). Required if name not provided. * * * * @type {string} * @memberof StudioApiVercelDeploymentStatus */ readonly deploymentId?: string; /** * Farcaster ID of the user; if not provided, namespace must be provided * * * * @type {number} * @memberof StudioApiVercelDeploymentStatus */ readonly fid?: number | null; /** * K8s Namespace name * * * * @type {string} * @memberof StudioApiVercelDeploymentStatus */ readonly namespace?: string; /** * Deployment name used to identify the Vercel project. Required if deployment_id not provided. * * * * @type {string} * @memberof StudioApiVercelDeploymentStatus */ readonly name?: string; } /** * StudioApi - object-oriented interface * @export * @class StudioApi * @extends {BaseAPI} */ export declare class StudioApi extends BaseAPI implements StudioApiInterface { /** * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Set account association * @param {StudioApiAssociateDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `AssociateDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/associate-deployment) * */ associateDeployment(requestParameters: StudioApiAssociateDeploymentRequest, options?: RawAxiosRequestConfig): Promise>; /** * Runs Next.js build process for the generated app. If build fails, automatically calls a build-fixer agent to resolve errors. Streams build output and agent responses via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Build generated app with automatic error fixing * @param {StudioApiBuildRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/build) * */ build(requestParameters: StudioApiBuildRequest, options?: RawAxiosRequestConfig): Promise>; /** * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Create a miniapp generator deployment * @param {StudioApiCreateDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/create-deployment) * */ createDeployment(requestParameters: StudioApiCreateDeploymentRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Delete deployment(s) * @param {StudioApiDeleteDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `DeleteDeployment200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-deployment) * */ deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk deletes. * @summary Delete rows from table * @param {StudioApiDeleteRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `DeleteRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-rows) * */ deleteRows(requestParameters: StudioApiDeleteRowsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Deletes environment variables (secrets) from a deployment. * @summary Delete deployment secrets * @param {StudioApiDeleteSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-secrets) * */ deleteSecrets(requestParameters: StudioApiDeleteSecretsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Publishes the generated miniapp to Vercel via GitHub. Creates a GitHub repository, pushes code, creates a Vercel project linked to GitHub, and triggers deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Deploy miniapp to Vercel * @param {StudioApiDeployToVercelRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `DeployToVercel200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/deploy-to-vercel) * */ deployToVercel(requestParameters: StudioApiDeployToVercelRequest, options?: RawAxiosRequestConfig): Promise>; /** * Executes a raw SQL query against the deployment database. Only SELECT, WITH, and EXPLAIN queries are allowed. Admin access required. * @summary Execute raw SQL query (admin only) * @param {StudioApiExecuteSqlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `ExecuteSql200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/execute-sql) * */ executeSql(requestParameters: StudioApiExecuteSqlRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the account-association.json file from a miniapp deployment, which contains the JFS-signed domain association. Requires API key authentication. * @summary Get account association of a miniapp * @param {StudioApiGetAccountAssociationRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `GetAccountAssociation200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-account-association) * */ getAccountAssociation(requestParameters?: StudioApiGetAccountAssociationRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves all messages in a specific conversation. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get messages in a conversation * @param {StudioApiGetConversationMessagesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `GetConversationMessages200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-conversation-messages) * */ getConversationMessages(requestParameters: StudioApiGetConversationMessagesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment info * @param {StudioApiGetDeploymentRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `ListDeployments200ResponseInner` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment) * */ getDeployment(requestParameters?: StudioApiGetDeploymentRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get deployment file contents * @param {StudioApiGetDeploymentFileRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `GetDeploymentFile200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment-file) * */ getDeploymentFile(requestParameters: StudioApiGetDeploymentFileRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get dev status of a miniapp * @param {StudioApiGetDevStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `GetDevStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-dev-status) * */ getDevStatus(requestParameters?: StudioApiGetDevStatusRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the complete schema for a table including columns, indexes, and foreign keys. * @summary Get table schema * @param {StudioApiGetTableSchemaRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `GetTableSchema200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-table-schema) * */ getTableSchema(requestParameters: StudioApiGetTableSchemaRequest, options?: RawAxiosRequestConfig): Promise>; /** * Inserts one or more rows into the specified table. Returns the inserted rows with generated values. * @summary Insert rows into table * @param {StudioApiInsertRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `InsertRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/insert-rows) * */ insertRows(requestParameters: StudioApiInsertRowsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Lists all conversations for a specific deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List conversations for a deployment * @param {StudioApiListConversationsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `ListConversations200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations) * */ listConversations(requestParameters?: StudioApiListConversationsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployment files * @param {StudioApiListDeploymentFilesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `ListDeploymentFiles200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployment-files) * */ listDeploymentFiles(requestParameters?: StudioApiListDeploymentFilesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary List deployments * @param {StudioApiListDeploymentsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise>} A promise that resolves to a `Array` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments) * */ listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves all secrets for a deployment. * @summary List deployment secrets * @param {StudioApiListSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `ListSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-secrets) * */ listSecrets(requestParameters: StudioApiListSecretsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Lists all tables and views in the deployment database, excluding system tables. * @summary List all tables in deployment database * @param {StudioApiListTablesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `ListTables200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-tables) * */ listTables(requestParameters: StudioApiListTablesRequest, options?: RawAxiosRequestConfig): Promise>; /** * Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Prompt a deployment with streaming response * @param {StudioApiPromptDeploymentStreamRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/prompt-deployment-stream) * */ promptDeploymentStream(requestParameters: StudioApiPromptDeploymentStreamRequest, options?: RawAxiosRequestConfig): Promise>; /** * Query data from a table with pagination and sorting. * @summary Query table data * @param {StudioApiQueryTableRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `QueryTable200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/query-table) * */ queryTable(requestParameters: StudioApiQueryTableRequest, options?: RawAxiosRequestConfig): Promise>; /** * Attempts to recover a broken dev server. Phase 1: reads dev server error logs and sends them to an AI agent for fixing, then waits for HMR to auto-rebuild. Phase 2: if HMR fails, falls back to a full npm build with AI retry loop. Streams progress events via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Recover dev server with two-phase strategy * @param {StudioApiRecoverRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise<>} A promise that resolves to a `` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/recover) * */ recover(requestParameters: StudioApiRecoverRequest, options?: RawAxiosRequestConfig): Promise>; /** * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Start generated miniapp * @param {StudioApiStartAppRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/start-app) * */ startApp(requestParameters: StudioApiStartAppRequest, options?: RawAxiosRequestConfig): Promise>; /** * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Stop generated miniapp * @param {StudioApiStopAppRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `StartApp200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/stop-app) * */ stopApp(requestParameters: StudioApiStopAppRequest, options?: RawAxiosRequestConfig): Promise>; /** * Updates rows matching the WHERE conditions. WHERE clause is required to prevent accidental bulk updates. * @summary Update rows in table * @param {StudioApiUpdateRowsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `UpdateRows200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-rows) * */ updateRows(requestParameters: StudioApiUpdateRowsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image to deployment * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image) * */ uploadImage(options?: RawAxiosRequestConfig): Promise>; /** * Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Upload image from URL to deployment * @param {StudioApiUploadImageUrlRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `UploadImage200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upload-image-url) * */ uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): Promise>; /** * Upsert secrets for a deployment. * @summary Upsert deployment secrets * @param {StudioApiUpsertSecretsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `UpsertSecrets200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/upsert-secrets) * */ upsertSecrets(requestParameters: StudioApiUpsertSecretsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment build logs * @param {StudioApiVercelDeploymentLogsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `VercelDeploymentLogs200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-logs) * */ vercelDeploymentLogs(requestParameters?: StudioApiVercelDeploymentLogsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call. * @summary Get Vercel deployment status * @param {StudioApiVercelDeploymentStatusRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StudioApi * @returns {Promise} A promise that resolves to a `VercelDeploymentStatus200Response` object * * For more information, refer to the [API documentation](https://docs.neynar.com/reference/vercel-deployment-status) * */ vercelDeploymentStatus(requestParameters?: StudioApiVercelDeploymentStatusRequest, options?: RawAxiosRequestConfig): Promise>; }