@neynar/nodejs-sdk 3.124.0 → 3.126.0

package/build/clients/NeynarAPIClient.d.ts

@@ -3160,7 +3160,7 @@ export declare class NeynarAPIClient {
         fid: number;
     }): Promise<StorageUsageResponse>;
     /**
-     * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication.
+     * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Set account association
      *
@@ -3185,7 +3185,7 @@ export declare class NeynarAPIClient {
         associateDeploymentRequest: AssociateDeploymentRequest;
     }): Promise<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.
+     * Runs Next.js build process for the generated app. If build fails, automatically calls a build-fixer agent to resolve errors. Streams build output and agent responses via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Build generated app with automatic error fixing
      *
@@ -3210,7 +3210,7 @@ export declare class NeynarAPIClient {
         buildRequest: BuildRequest;
     }): Promise<void>;
     /**
-     * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
+     * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Create a miniapp generator deployment
      *
@@ -3235,7 +3235,7 @@ export declare class NeynarAPIClient {
         createDeploymentRequest: CreateDeploymentRequest;
     }): Promise<ListDeployments200ResponseInner>;
     /**
-     * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
+     * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Delete deployment(s)
      *
@@ -3285,7 +3285,7 @@ export declare class NeynarAPIClient {
         deleteSecretsRequest: DeleteSecretsRequest;
     }): Promise<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.
+     * Publishes the generated miniapp to Vercel via GitHub. Creates a GitHub repository, pushes code, creates a Vercel project linked to GitHub, and triggers deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Deploy miniapp to Vercel
      *
@@ -3341,7 +3341,7 @@ export declare class NeynarAPIClient {
         name?: string;
     }): Promise<GetAccountAssociation200Response>;
     /**
-     * Retrieves all messages in a specific conversation. Requires API key authentication.
+     * Retrieves all messages in a specific conversation. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get messages in a conversation
      *
@@ -3381,7 +3381,7 @@ export declare class NeynarAPIClient {
         includeDeleted?: boolean | null;
     }): Promise<GetConversationMessages200Response>;
     /**
-     * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication.
+     * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get deployment info
      *
@@ -3415,7 +3415,7 @@ export declare class NeynarAPIClient {
         namespace?: string;
     }): Promise<ListDeployments200ResponseInner>;
     /**
-     * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation.
+     * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get deployment file contents
      *
@@ -3452,7 +3452,7 @@ export declare class NeynarAPIClient {
         namespace?: string;
     }): Promise<GetDeploymentFile200Response>;
     /**
-     * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication.
+     * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get dev status of a miniapp
      *
@@ -3483,7 +3483,7 @@ export declare class NeynarAPIClient {
         name?: string;
     }): Promise<GetDevStatus200Response>;
     /**
-     * Lists all conversations for a specific deployment. Requires API key authentication.
+     * Lists all conversations for a specific deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary List conversations for a deployment
      *
@@ -3517,7 +3517,7 @@ export declare class NeynarAPIClient {
         includeDeleted?: boolean | null;
     }): Promise<ListConversations200Response>;
     /**
-     * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation.
+     * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary List deployment files
      *
@@ -3554,7 +3554,7 @@ export declare class NeynarAPIClient {
         directory?: string;
     }): Promise<ListDeploymentFiles200Response>;
     /**
-     * Lists all miniapp generator deployments for a user. Requires API key authentication.
+     * Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary List deployments
      *
@@ -3619,7 +3619,7 @@ export declare class NeynarAPIClient {
         environment?: ListSecretsEnvironmentEnum;
     }): Promise<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.
+     * Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Prompt a deployment with streaming response
      *
@@ -3644,7 +3644,7 @@ export declare class NeynarAPIClient {
         promptDeploymentStreamRequest: PromptDeploymentStreamRequest;
     }): Promise<void>;
     /**
-     * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
+     * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Start generated miniapp
      *
@@ -3669,7 +3669,7 @@ export declare class NeynarAPIClient {
         startAppRequest: StartAppRequest;
     }): Promise<StartApp200Response>;
     /**
-     * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
+     * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Stop generated miniapp
      *
@@ -3694,7 +3694,7 @@ export declare class NeynarAPIClient {
         startAppRequest: StartAppRequest;
     }): Promise<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.
+     * Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Upload image to deployment
      *
@@ -3719,7 +3719,7 @@ export declare class NeynarAPIClient {
         uploadImageUrlRequest: UploadImageUrlRequest;
     }): Promise<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.
+     * Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Upload image from URL to deployment
      *
@@ -3769,7 +3769,7 @@ export declare class NeynarAPIClient {
         upsertSecretsRequest: UpsertSecretsRequest;
     }): Promise<UpsertSecrets200Response>;
     /**
-     * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
+     * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get Vercel deployment build logs
      *
@@ -3806,7 +3806,7 @@ export declare class NeynarAPIClient {
         limit?: number;
     }): Promise<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.
+     * Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get Vercel deployment status
      *

package/build/clients/NeynarAPIClient.js

@@ -3504,7 +3504,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication.
+     * Associates a generated miniapp with a Farcaster account using a JFS-signed domain association. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Set account association
      *
@@ -3532,7 +3532,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * 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.
+     * Runs Next.js build process for the generated app. If build fails, automatically calls a build-fixer agent to resolve errors. Streams build output and agent responses via Server-Sent Events. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Build generated app with automatic error fixing
      *
@@ -3560,7 +3560,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header.
+     * Creates and deploys an instance of the miniapp generator for a user. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Create a miniapp generator deployment
      *
@@ -3588,7 +3588,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication.
+     * Deletes a specific miniapp generator deployment or all deployments for a FID. If deployment_id or name is provided, deletes single deployment. If only FID is provided, deletes all deployments for that FID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Delete deployment(s)
      *
@@ -3644,7 +3644,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * 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.
+     * Publishes the generated miniapp to Vercel via GitHub. Creates a GitHub repository, pushes code, creates a Vercel project linked to GitHub, and triggers deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Deploy miniapp to Vercel
      *
@@ -3704,7 +3704,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Retrieves all messages in a specific conversation. Requires API key authentication.
+     * Retrieves all messages in a specific conversation. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get messages in a conversation
      *
@@ -3742,7 +3742,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication.
+     * Fetches info about a miniapp generator deployment by its deployment_id or name and creator\'s Farcaster ID. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get deployment info
      *
@@ -3776,7 +3776,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation.
+     * Retrieves the contents of a specific file from the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get deployment file contents
      *
@@ -3812,7 +3812,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication.
+     * Retrieves the dev-status.json file from a miniapp deployment, which tracks the progress of app development phases. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get dev status of a miniapp
      *
@@ -3844,7 +3844,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Lists all conversations for a specific deployment. Requires API key authentication.
+     * Lists all conversations for a specific deployment. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary List conversations for a deployment
      *
@@ -3878,7 +3878,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation.
+     * Lists files in a directory of the generated app. Requires Studio admin authentication or FID ownership validation. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary List deployment files
      *
@@ -3914,7 +3914,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Lists all miniapp generator deployments for a user. Requires API key authentication.
+     * Lists all miniapp generator deployments for a user. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary List deployments
      *
@@ -3980,7 +3980,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * 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.
+     * Sends a prompt to a specific miniapp generator deployment and returns a streaming response using Server-Sent Events. The response is a continuous stream of Server-Sent Events, not a single JSON payload. Each event contains a JSON object with type, message, and other fields specific to the message type. Requires authentication via API key in the request header. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Prompt a deployment with streaming response
      *
@@ -4008,7 +4008,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication.
+     * Starts the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Start generated miniapp
      *
@@ -4036,7 +4036,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication.
+     * Stops the Next.js development server for the generated miniapp. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Stop generated miniapp
      *
@@ -4064,7 +4064,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * 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.
+     * Uploads an image file to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Upload image to deployment
      *
@@ -4092,7 +4092,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * 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.
+     * Downloads an image from the provided URL and saves it to the generated miniapp public folder. The image will be accessible as a static asset on the deployed miniapp. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Upload image from URL to deployment
      *
@@ -4148,7 +4148,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication.
+     * Retrieves the build logs for a Vercel deployment. Useful for debugging failed deployments. Requires Studio admin authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get Vercel deployment build logs
      *
@@ -4184,7 +4184,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * 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.
+     * Retrieves the status of a Vercel deployment for a miniapp. Looks up the Vercel project ID from the deployment and queries Vercel API for deployment status. Requires API key authentication. Note: Studio CU is tracked based on LLM token usage, not per API call.
      *
      * @summary Get Vercel deployment status
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neynar/nodejs-sdk",
-  "version": "3.124.0",
+  "version": "3.126.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/neynarxyz/nodejs-sdk.git"