@neynar/nodejs-sdk 3.81.2 → 3.83.0

package/build/api/apis/studio-api.d.ts

@@ -2,7 +2,7 @@
  * 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.81.0
+ * The version of the OpenAPI document: 3.83.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -17,6 +17,8 @@ import type { AssociateDeploymentRequest } 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 { GetDeploymentLogs200Response } from '../models';
@@ -29,6 +31,8 @@ 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
@@ -70,6 +74,18 @@ export declare const StudioApiAxiosParamCreator: (configuration?: Configuration)
      *
      */
     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
@@ -239,6 +255,33 @@ export declare const StudioApiAxiosParamCreator: (configuration?: Configuration)
      *
      */
     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 {number | null} fid Farcaster ID of the user
+     * @param {string} name Deployment name used to identify the Vercel project
+     * @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: (fid: number | null, name: 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 {number | null} fid Farcaster ID of the user
+     * @param {string} name Deployment name used to identify the Vercel project
+     * @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: (fid: number | null, name: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * StudioApi - functional programming interface
@@ -281,6 +324,18 @@ export declare const StudioApiFp: (configuration?: Configuration) => {
      *
      */
     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
@@ -450,6 +505,33 @@ export declare const StudioApiFp: (configuration?: Configuration) => {
      *
      */
     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 {number | null} fid Farcaster ID of the user
+     * @param {string} name Deployment name used to identify the Vercel project
+     * @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(fid: number | null, name: 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 {number | null} fid Farcaster ID of the user
+     * @param {string} name Deployment name used to identify the Vercel project
+     * @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(fid: number | null, name: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VercelDeploymentStatus200Response>>;
 };
 /**
  * StudioApi - factory interface
@@ -492,6 +574,18 @@ export declare const StudioApiFactory: (configuration?: Configuration, basePath?
      *
      */
     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
@@ -647,6 +741,30 @@ export declare const StudioApiFactory: (configuration?: Configuration, basePath?
      *
      */
     uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): 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 {StudioApiVercelDeploymentLogsRequest} requestParameters Request parameters.
+     * @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(requestParameters: StudioApiVercelDeploymentLogsRequest, options?: RawAxiosRequestConfig): 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 {StudioApiVercelDeploymentStatusRequest} requestParameters Request parameters.
+     * @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(requestParameters: StudioApiVercelDeploymentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<VercelDeploymentStatus200Response>;
 };
 /**
  * StudioApi - interface
@@ -693,6 +811,19 @@ export interface StudioApiInterface {
      *
      */
     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}
+     * @memberof StudioApiInterface
+     * @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
@@ -861,6 +992,32 @@ export interface StudioApiInterface {
      *
      */
     uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): 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 {StudioApiVercelDeploymentLogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StudioApiInterface
+     * @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(requestParameters: StudioApiVercelDeploymentLogsRequest, options?: RawAxiosRequestConfig): 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 {StudioApiVercelDeploymentStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StudioApiInterface
+     * @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(requestParameters: StudioApiVercelDeploymentStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<VercelDeploymentStatus200Response>;
 }
 /**
  * Request parameters for associateDeployment operation in StudioApi.
@@ -910,6 +1067,22 @@ export interface StudioApiDeleteDeploymentRequest {
      */
     readonly deleteDeploymentRequest: DeleteDeploymentRequest;
 }
+/**
+ * Request parameters for deployToVercel operation in StudioApi.
+ * @export
+ * @interface StudioApiDeployToVercelRequest
+ */
+export interface StudioApiDeployToVercelRequest {
+    /**
+     *
+     *
+     *
+     *
+     * @type {DeployToVercelRequest}
+     * @memberof StudioApiDeployToVercel
+     */
+    readonly deployToVercelRequest: DeployToVercelRequest;
+}
 /**
  * Request parameters for getConversationMessages operation in StudioApi.
  * @export
@@ -1228,6 +1401,65 @@ export interface StudioApiUploadImageUrlRequest {
      */
     readonly uploadImageUrlRequest: UploadImageUrlRequest;
 }
+/**
+ * Request parameters for vercelDeploymentLogs operation in StudioApi.
+ * @export
+ * @interface StudioApiVercelDeploymentLogsRequest
+ */
+export interface StudioApiVercelDeploymentLogsRequest {
+    /**
+     * Farcaster ID of the user
+     *
+     *
+     *
+     * @type {number}
+     * @memberof StudioApiVercelDeploymentLogs
+     */
+    readonly fid: number | null;
+    /**
+     * Deployment name used to identify the Vercel project
+     *
+     *
+     *
+     * @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 {
+    /**
+     * Farcaster ID of the user
+     *
+     *
+     *
+     * @type {number}
+     * @memberof StudioApiVercelDeploymentStatus
+     */
+    readonly fid: number | null;
+    /**
+     * Deployment name used to identify the Vercel project
+     *
+     *
+     *
+     * @type {string}
+     * @memberof StudioApiVercelDeploymentStatus
+     */
+    readonly name: string;
+}
 /**
  * StudioApi - object-oriented interface
  * @export
@@ -1274,6 +1506,19 @@ export declare class StudioApi extends BaseAPI implements StudioApiInterface {
      *
      */
     deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteDeployment200Response, any, {}>>;
+    /**
+     * 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}
+     * @memberof StudioApi
+     * @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): Promise<import("axios").AxiosResponse<DeployToVercel200Response, any, {}>>;
     /**
      * Retrieves all messages in a specific conversation. Requires API key authentication.
      * @summary Get messages in a conversation
@@ -1442,4 +1687,30 @@ export declare class StudioApi extends BaseAPI implements StudioApiInterface {
      *
      */
     uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadImage200Response, any, {}>>;
+    /**
+     * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
+     * @summary Get Vercel deployment build logs
+     * @param {StudioApiVercelDeploymentLogsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StudioApi
+     * @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(requestParameters: StudioApiVercelDeploymentLogsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VercelDeploymentLogs200Response, any, {}>>;
+    /**
+     * 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 {StudioApiVercelDeploymentStatusRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof StudioApi
+     * @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(requestParameters: StudioApiVercelDeploymentStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VercelDeploymentStatus200Response, any, {}>>;
 }