@neynar/nodejs-sdk/build/api/apis/studio-api.d.ts

SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)

/**
 * 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.115.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 { DeployToVercel200Response } from '../models';
import type { DeployToVercelRequest } from '../models';
import type { GetConversationMessages200Response } from '../models';
import type { GetDeploymentFile200Response } from '../models';
import type { GetDevStatus200Response } from '../models';
import type { ListConversations200Response } from '../models';
import type { ListDeploymentFiles200Response } from '../models';
import type { ListDeployments200ResponseInner } from '../models';
import type { PromptDeploymentStreamRequest } from '../models';
import type { StartApp200Response } from '../models';
import type { StartAppRequest } from '../models';
import type { UploadImage200Response } from '../models';
import type { UploadImageUrlRequest } 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.
     * @summary Set account association
     * @param {AssociateDeploymentRequest} associateDeploymentRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<AssociateDeployment200Response>} 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<RequestArgs>;
    /**
     * 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.
     * @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<RequestArgs>;
    /**
     * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
     * @summary Create a miniapp generator deployment
     * @param {CreateDeploymentRequest} createDeploymentRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<ListDeployments200ResponseInner>} 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<RequestArgs>;
    /**
     * Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
     * @summary Delete deployment(s)
     * @param {DeleteDeploymentRequest} deleteDeploymentRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeleteDeployment200Response>} 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<RequestArgs>;
    /**
     * 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.
     * @summary Deploy miniapp to Vercel
     * @param {DeployToVercelRequest} deployToVercelRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeployToVercel200Response>} 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<RequestArgs>;
    /**
     * Retrieves all messages in a specific conversation. Requires API key authentication.
     * @summary Get messages in a conversation
     * @param {string} name Kubernetes deployment name
     * @param {string} conversationId Conversation ID
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<GetConversationMessages200Response>} 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: (name: string, conversationId: string, fid?: number | null, namespace?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
     * @summary Get deployment info
     * @param {string} name Kubernetes deployment name
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment)
     *
     */
    getDeployment: (name: string, fid?: number | null, namespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
     * @summary Get deployment file contents
     * @param {string} name Kubernetes deployment name
     * @param {string} filePath File path relative to gen/
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<GetDeploymentFile200Response>} 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: (name: string, filePath: string, fid?: number | null, namespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication.
     * @summary Get dev status of a miniapp
     * @param {string} namespace Kubernetes namespace name
     * @param {string} name Kubernetes deployment name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<GetDevStatus200Response>} 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: (namespace: string, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists all conversations for a specific deployment. Requires API key authentication.
     * @summary List conversations for a deployment
     * @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<ListConversations200Response>} A promise that resolves to a `ListConversations200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations)
     *
     */
    listConversations: (fid?: number | null, name?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists files in a directory of the generated app. Requires Studio admin authentication.
     * @summary List deployment files
     * @param {string} name Kubernetes deployment name
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<ListDeploymentFiles200Response>} 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: (name: string, fid?: number | null, namespace?: string, directory?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Lists all miniapp generator deployments for a user. Requires API key authentication.
     * @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<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` 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<RequestArgs>;
    /**
     * 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.
     * @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<RequestArgs>;
    /**
     * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
     * @summary Start generated miniapp
     * @param {StartAppRequest} startAppRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<StartApp200Response>} 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<RequestArgs>;
    /**
     * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
     * @summary Stop generated miniapp
     * @param {StartAppRequest} startAppRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<StartApp200Response>} 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<RequestArgs>;
    /**
     * 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.
     * @summary Upload image to deployment
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<UploadImage200Response>} 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<RequestArgs>;
    /**
     * 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.
     * @summary Upload image from URL to deployment
     * @param {UploadImageUrlRequest} uploadImageUrlRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<UploadImage200Response>} 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<RequestArgs>;
    /**
     * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
     * @summary Get Vercel deployment build logs
     * @param {string} name Deployment name used to identify the Vercel project
     * @param {number | null} [fid] Farcaster ID of the user
     * @param {string} [namespace] K8s Namespace name
     * @param {number} [limit] Maximum number of log events to return. Defaults to 100.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<VercelDeploymentLogs200Response>} 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: (name: string, fid?: number | null, namespace?: string, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * 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.
     * @summary Get Vercel deployment status
     * @param {string} name Deployment name used to identify the Vercel project
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided
     * @param {string} [namespace] K8s Namespace name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<VercelDeploymentStatus200Response>} 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: (name: string, fid?: number | null, namespace?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * 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.
     * @summary Set account association
     * @param {AssociateDeploymentRequest} associateDeploymentRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<AssociateDeployment200Response>} 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<AssociateDeployment200Response>>;
    /**
     * 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.
     * @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<void>>;
    /**
     * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
     * @summary Create a miniapp generator deployment
     * @param {CreateDeploymentRequest} createDeploymentRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<ListDeployments200ResponseInner>} 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<ListDeployments200ResponseInner>>;
    /**
     * Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
     * @summary Delete deployment(s)
     * @param {DeleteDeploymentRequest} deleteDeploymentRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeleteDeployment200Response>} 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<DeleteDeployment200Response>>;
    /**
     * 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.
     * @summary Deploy miniapp to Vercel
     * @param {DeployToVercelRequest} deployToVercelRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeployToVercel200Response>} 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<DeployToVercel200Response>>;
    /**
     * Retrieves all messages in a specific conversation. Requires API key authentication.
     * @summary Get messages in a conversation
     * @param {string} name Kubernetes deployment name
     * @param {string} conversationId Conversation ID
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<GetConversationMessages200Response>} 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(name: string, conversationId: string, fid?: number | null, namespace?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetConversationMessages200Response>>;
    /**
     * Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
     * @summary Get deployment info
     * @param {string} name Kubernetes deployment name
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-deployment)
     *
     */
    getDeployment(name: string, fid?: number | null, namespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDeployments200ResponseInner>>;
    /**
     * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
     * @summary Get deployment file contents
     * @param {string} name Kubernetes deployment name
     * @param {string} filePath File path relative to gen/
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<GetDeploymentFile200Response>} 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(name: string, filePath: string, fid?: number | null, namespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDeploymentFile200Response>>;
    /**
     * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication.
     * @summary Get dev status of a miniapp
     * @param {string} namespace Kubernetes namespace name
     * @param {string} name Kubernetes deployment name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<GetDevStatus200Response>} 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(namespace: string, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDevStatus200Response>>;
    /**
     * Lists all conversations for a specific deployment. Requires API key authentication.
     * @summary List conversations for a deployment
     * @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<ListConversations200Response>} A promise that resolves to a `ListConversations200Response` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-conversations)
     *
     */
    listConversations(fid?: number | null, name?: string, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListConversations200Response>>;
    /**
     * Lists files in a directory of the generated app. Requires Studio admin authentication.
     * @summary List deployment files
     * @param {string} name Kubernetes deployment name
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be 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<ListDeploymentFiles200Response>} 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(name: string, fid?: number | null, namespace?: string, directory?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDeploymentFiles200Response>>;
    /**
     * Lists all miniapp generator deployments for a user. Requires API key authentication.
     * @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<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` 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<Array<ListDeployments200ResponseInner>>>;
    /**
     * 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.
     * @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<void>>;
    /**
     * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
     * @summary Start generated miniapp
     * @param {StartAppRequest} startAppRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<StartApp200Response>} 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<StartApp200Response>>;
    /**
     * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
     * @summary Stop generated miniapp
     * @param {StartAppRequest} startAppRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<StartApp200Response>} 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<StartApp200Response>>;
    /**
     * 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.
     * @summary Upload image to deployment
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<UploadImage200Response>} 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<UploadImage200Response>>;
    /**
     * 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.
     * @summary Upload image from URL to deployment
     * @param {UploadImageUrlRequest} uploadImageUrlRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<UploadImage200Response>} 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<UploadImage200Response>>;
    /**
     * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
     * @summary Get Vercel deployment build logs
     * @param {string} name Deployment name used to identify the Vercel project
     * @param {number | null} [fid] Farcaster ID of the user
     * @param {string} [namespace] K8s Namespace name
     * @param {number} [limit] Maximum number of log events to return. Defaults to 100.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<VercelDeploymentLogs200Response>} 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(name: string, fid?: number | null, namespace?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VercelDeploymentLogs200Response>>;
    /**
     * 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.
     * @summary Get Vercel deployment status
     * @param {string} name Deployment name used to identify the Vercel project
     * @param {number | null} [fid] Farcaster ID of the user; if not provided, namespace must be provided
     * @param {string} [namespace] K8s Namespace name
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<VercelDeploymentStatus200Response>} 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(name: string, fid?: number | null, namespace?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VercelDeploymentStatus200Response>>;
};
/**
 * 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.
     * @summary Set account association
     * @param {StudioApiAssociateDeploymentRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<AssociateDeployment200Response>} 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<AssociateDeployment200Response>;
    /**
     * 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.
     * @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<void>;
    /**
     * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
     * @summary Create a miniapp generator deployment
     * @param {StudioApiCreateDeploymentRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<ListDeployments200ResponseInner>} 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<ListDeployments200ResponseInner>;
    /**
     * Deletes a specific miniapp generator deployment or all deployments for a FID. If name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
     * @summary Delete deployment(s)
     * @param {StudioApiDeleteDeploymentRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeleteDeployment200Response>} 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<DeleteDeployment200Response>;
    /**
     * 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.
     * @summary Deploy miniapp to Vercel
     * @param {StudioApiDeployToVercelRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<DeployToVercel200Response>} 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<DeployToVercel200Response>;
    /**
     * Retrieves all messages in a specific conversation. Requires API key authentication.
     * @summary Get messages in a conversation
     * @param {StudioApiGetConversationMessagesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<GetConversationMessages200Response>} 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<GetConversationMessages200Response>;
    /**
     * Fetches info about a miniapp generator deployment by its name and creator\'s Farcaster ID. Requires API key authentication.
     * @summary Get deployment info
     * @param {StudioApiGetDeploymentRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<ListDeployments200ResponseInner>} 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<ListDeployments200ResponseInner>;
    /**
     * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication.
     * @summary Get deployment file contents
     * @param {StudioApiGetDeploymentFileRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<GetDeploymentFile200Response>} 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<GetDeploymentFile200Response>;
    /**
     * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication.
     * @summary Get dev status of a miniapp
     * @param {StudioApiGetDevStatusRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<GetDevStatus200Response>} 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<GetDevStatus200Response>;
    /**
     * Lists all conversations for a specific deployment. Requires API key authentication.
     * @summary List conversations for a deployment
     * @param {StudioApiListConversationsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<ListConversations200Response>} 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<ListConversations200Response>;
    /**
     * Lists files in a directory of the generated app. Requires Studio admin authentication.
     * @summary List deployment files
     * @param {StudioApiListDeploymentFilesRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<ListDeploymentFiles200Response>} 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<ListDeploymentFiles200Response>;
    /**
     * Lists all miniapp generator deployments for a user. Requires API key authentication.
     * @summary List deployments
     * @param {StudioApiListDeploymentsRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<Array<ListDeployments200ResponseInner>>} A promise that resolves to a `Array<ListDeployments200ResponseInner>` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-deployments)
     *
     */
    listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ListDeployments200ResponseInner>>;
    /**
     * 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.
     * @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<void>;
    /**
     * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
     * @summary Start generated miniapp
     * @param {StudioApiStartAppRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<StartApp200Response>} 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<StartApp200Response>;
    /**
     * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
     * @summary Stop generated miniapp
     * @param {StudioApiStopAppRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<StartApp200Response>} 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<StartApp200Response>;
    /**
     * 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.
     * @summary Upload image to deployment
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<UploadImage200Response>} 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<UploadImage200Response>;
    /**
     * 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.
     * @summary Upload image from URL to deployment
     * @param {StudioApiUploadImageUrlRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<UploadImage200Response>} 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?: RawAxiosRequestCon