@neynar/nodejs-sdk 3.119.1 → 3.120.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.119.1
+ * The version of the OpenAPI document: 3.120.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -18,6 +18,7 @@ import type { BuildRequest } from '../models';
 import type { CreateDeploymentRequest } from '../models';
 import type { DeleteDeployment200Response } from '../models';
 import type { DeleteDeploymentRequest } from '../models';
+import type { DeleteSecretsRequest } from '../models';
 import type { DeployToVercel200Response } from '../models';
 import type { DeployToVercelRequest } from '../models';
 import type { GetConversationMessages200Response } from '../models';
@@ -26,11 +27,14 @@ import type { GetDevStatus200Response } from '../models';
 import type { ListConversations200Response } from '../models';
 import type { ListDeploymentFiles200Response } from '../models';
 import type { ListDeployments200ResponseInner } from '../models';
+import type { ListSecrets200Response } 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 { UpsertSecrets200Response } from '../models';
+import type { UpsertSecretsRequest } from '../models';
 import type { VercelDeploymentLogs200Response } from '../models';
 import type { VercelDeploymentStatus200Response } from '../models';
 /**
@@ -86,6 +90,18 @@ export declare const StudioApiAxiosParamCreator: (configuration?: Configuration)
      *
      */
     deleteDeployment: (deleteDeploymentRequest: DeleteDeploymentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes environment variables (secrets) from a deployment.
+     * @summary Delete deployment secrets
+     * @param {DeleteSecretsRequest} deleteSecretsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<UpsertSecrets200Response>} 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<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
@@ -206,6 +222,20 @@ export declare const StudioApiAxiosParamCreator: (configuration?: Configuration)
      *
      */
     listDeployments: (fid?: number | null, limit?: number, offset?: number | null, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {ListSecretsEnvironmentEnum} [environment] Optional filter by target environment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<ListSecrets200Response>} 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, environment?: ListSecretsEnvironmentEnum, 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
@@ -265,6 +295,18 @@ export declare const StudioApiAxiosParamCreator: (configuration?: Configuration)
      *
      */
     uploadImageUrl: (uploadImageUrlRequest: UploadImageUrlRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Upsert secrets for a deployment.
+     * @summary Upsert deployment secrets
+     * @param {UpsertSecretsRequest} upsertSecretsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<UpsertSecrets200Response>} 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<RequestArgs>;
     /**
      * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
      * @summary Get Vercel deployment build logs
@@ -350,6 +392,18 @@ export declare const StudioApiFp: (configuration?: Configuration) => {
      *
      */
     deleteDeployment(deleteDeploymentRequest: DeleteDeploymentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteDeployment200Response>>;
+    /**
+     * Deletes environment variables (secrets) from a deployment.
+     * @summary Delete deployment secrets
+     * @param {DeleteSecretsRequest} deleteSecretsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<UpsertSecrets200Response>} 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<UpsertSecrets200Response>>;
     /**
      * 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
@@ -470,6 +524,20 @@ export declare const StudioApiFp: (configuration?: Configuration) => {
      *
      */
     listDeployments(fid?: number | null, limit?: number, offset?: number | null, includeDeleted?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ListDeployments200ResponseInner>>>;
+    /**
+     * 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 {ListSecretsEnvironmentEnum} [environment] Optional filter by target environment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<ListSecrets200Response>} 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, environment?: ListSecretsEnvironmentEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSecrets200Response>>;
     /**
      * 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
@@ -529,6 +597,18 @@ export declare const StudioApiFp: (configuration?: Configuration) => {
      *
      */
     uploadImageUrl(uploadImageUrlRequest: UploadImageUrlRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadImage200Response>>;
+    /**
+     * Upsert secrets for a deployment.
+     * @summary Upsert deployment secrets
+     * @param {UpsertSecretsRequest} upsertSecretsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<UpsertSecrets200Response>} 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<UpsertSecrets200Response>>;
     /**
      * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
      * @summary Get Vercel deployment build logs
@@ -614,6 +694,18 @@ export declare const StudioApiFactory: (configuration?: Configuration, basePath?
      *
      */
     deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteDeployment200Response>;
+    /**
+     * 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<UpsertSecrets200Response>} 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<UpsertSecrets200Response>;
     /**
      * 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
@@ -710,6 +802,18 @@ export declare const StudioApiFactory: (configuration?: Configuration, basePath?
      *
      */
     listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ListDeployments200ResponseInner>>;
+    /**
+     * 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<ListSecrets200Response>} 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<ListSecrets200Response>;
     /**
      * 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
@@ -769,6 +873,18 @@ export declare const StudioApiFactory: (configuration?: Configuration, basePath?
      *
      */
     uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadImage200Response>;
+    /**
+     * Upsert secrets for a deployment.
+     * @summary Upsert deployment secrets
+     * @param {StudioApiUpsertSecretsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<UpsertSecrets200Response>} 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<UpsertSecrets200Response>;
     /**
      * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
      * @summary Get Vercel deployment build logs
@@ -852,6 +968,19 @@ export interface StudioApiInterface {
      *
      */
     deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<DeleteDeployment200Response>;
+    /**
+     * 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<UpsertSecrets200Response>} 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<UpsertSecrets200Response>;
     /**
      * 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
@@ -956,6 +1085,19 @@ export interface StudioApiInterface {
      *
      */
     listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<ListDeployments200ResponseInner>>;
+    /**
+     * 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<ListSecrets200Response>} 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<ListSecrets200Response>;
     /**
      * 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
@@ -1020,6 +1162,19 @@ export interface StudioApiInterface {
      *
      */
     uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): AxiosPromise<UploadImage200Response>;
+    /**
+     * 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<UpsertSecrets200Response>} 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<UpsertSecrets200Response>;
     /**
      * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
      * @summary Get Vercel deployment build logs
@@ -1111,6 +1266,22 @@ export interface StudioApiDeleteDeploymentRequest {
      */
     readonly deleteDeploymentRequest: DeleteDeploymentRequest;
 }
+/**
+ * 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
@@ -1455,6 +1626,40 @@ export interface StudioApiListDeploymentsRequest {
      */
     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;
+    /**
+     * Optional filter by target environment
+     *
+     *
+     *
+     * @type {'development' | 'preview' | 'production'}
+     * @memberof StudioApiListSecrets
+     */
+    readonly environment?: ListSecretsEnvironmentEnum;
+}
 /**
  * Request parameters for promptDeploymentStream operation in StudioApi.
  * @export
@@ -1519,6 +1724,22 @@ export interface StudioApiUploadImageUrlRequest {
      */
     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
@@ -1673,6 +1894,19 @@ export declare class StudioApi extends BaseAPI implements StudioApiInterface {
      *
      */
     deleteDeployment(requestParameters: StudioApiDeleteDeploymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteDeployment200Response, any, {}>>;
+    /**
+     * 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<UpsertSecrets200Response>} 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<import("axios").AxiosResponse<UpsertSecrets200Response, 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
@@ -1777,6 +2011,19 @@ export declare class StudioApi extends BaseAPI implements StudioApiInterface {
      *
      */
     listDeployments(requestParameters?: StudioApiListDeploymentsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListDeployments200ResponseInner[], any, {}>>;
+    /**
+     * 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<ListSecrets200Response>} 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<import("axios").AxiosResponse<ListSecrets200Response, any, {}>>;
     /**
      * 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
@@ -1841,6 +2088,19 @@ export declare class StudioApi extends BaseAPI implements StudioApiInterface {
      *
      */
     uploadImageUrl(requestParameters: StudioApiUploadImageUrlRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadImage200Response, any, {}>>;
+    /**
+     * 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<UpsertSecrets200Response>} 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<import("axios").AxiosResponse<UpsertSecrets200Response, any, {}>>;
     /**
      * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
      * @summary Get Vercel deployment build logs
@@ -1868,3 +2128,12 @@ export declare class StudioApi extends BaseAPI implements StudioApiInterface {
      */
     vercelDeploymentStatus(requestParameters?: StudioApiVercelDeploymentStatusRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VercelDeploymentStatus200Response, any, {}>>;
 }
+/**
+ * @export
+ */
+export declare const ListSecretsEnvironmentEnum: {
+    readonly Development: "development";
+    readonly Preview: "preview";
+    readonly Production: "production";
+};
+export type ListSecretsEnvironmentEnum = typeof ListSecretsEnvironmentEnum[keyof typeof ListSecretsEnvironmentEnum];