@neynar/nodejs-sdk 3.117.0 → 3.118.0

package/build/clients/NeynarAPIClient.d.ts

@@ -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 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.
      *
      * @summary Delete deployment(s)
      *
@@ -3290,9 +3290,10 @@ export declare class NeynarAPIClient {
      * @summary Get messages in a conversation
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
      * @param {string} params.conversationId  - Conversation ID
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      * @param {boolean | null} params.includeDeleted [optional]  - Include deleted messages in the response. Defaults to false.
      *
@@ -3301,13 +3302,14 @@ export declare class NeynarAPIClient {
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
      * const conversationId =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      * const includeDeleted =
      *
-     * client.getConversationMessages({ name, conversationId, fid, namespace, includeDeleted }).then(response => {
+     * client.getConversationMessages({ conversationId, deploymentId, fid, name, namespace, includeDeleted }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3315,20 +3317,22 @@ export declare class NeynarAPIClient {
      *
      */
     getConversationMessages(params: {
-        name: string;
         conversationId: string;
+        deploymentId?: string;
         fid?: number | null;
+        name?: string;
         namespace?: string;
         includeDeleted?: boolean | null;
     }): Promise<GetConversationMessages200Response>;
     /**
-     * Fetches info about a miniapp generator deployment by its 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.
      *
      * @summary Get deployment info
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      *
      * @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object.
@@ -3336,11 +3340,12 @@ export declare class NeynarAPIClient {
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      *
-     * client.getDeployment({ name, fid, namespace }).then(response => {
+     * client.getDeployment({ deploymentId, fid, name, namespace }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3348,8 +3353,9 @@ export declare class NeynarAPIClient {
      *
      */
     getDeployment(params: {
-        name: string;
+        deploymentId?: string;
         fid?: number | null;
+        name?: string;
         namespace?: string;
     }): Promise<ListDeployments200ResponseInner>;
     /**
@@ -3358,9 +3364,10 @@ export declare class NeynarAPIClient {
      * @summary Get deployment file contents
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
      * @param {string} params.filePath  - File path relative to gen/
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      *
      * @returns {Promise<GetDeploymentFile200Response>} A promise that resolves to a `GetDeploymentFile200Response` object.
@@ -3368,12 +3375,13 @@ export declare class NeynarAPIClient {
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
      * const filePath =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      *
-     * client.getDeploymentFile({ name, filePath, fid, namespace }).then(response => {
+     * client.getDeploymentFile({ filePath, deploymentId, fid, name, namespace }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3381,9 +3389,10 @@ export declare class NeynarAPIClient {
      *
      */
     getDeploymentFile(params: {
-        name: string;
         filePath: string;
+        deploymentId?: string;
         fid?: number | null;
+        name?: string;
         namespace?: string;
     }): Promise<GetDeploymentFile200Response>;
     /**
@@ -3392,18 +3401,20 @@ export declare class NeynarAPIClient {
      * @summary Get dev status of a miniapp
      *
      * @param {object} params
-     * @param {string} params.namespace  - Kubernetes namespace name
-     * @param {string} params.name  - Kubernetes deployment name
+     * @param {string} params.deploymentId [optional]  - Deployment ID
+     * @param {string} params.namespace [optional]  - Kubernetes namespace name
+     * @param {string} params.name [optional]  - Kubernetes deployment name
      *
      * @returns {Promise<GetDevStatus200Response>} A promise that resolves to a `GetDevStatus200Response` object.
      *
      * @example
      *
      * // Fill in the appropriate values
+     * const deploymentId =
      * const namespace =
      * const name =
      *
-     * client.getDevStatus({ namespace, name }).then(response => {
+     * client.getDevStatus({ deploymentId, namespace, name }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3411,8 +3422,9 @@ export declare class NeynarAPIClient {
      *
      */
     getDevStatus(params: {
-        namespace: string;
-        name: string;
+        deploymentId?: string;
+        namespace?: string;
+        name?: string;
     }): Promise<GetDevStatus200Response>;
     /**
      * Lists all conversations for a specific deployment. Requires API key authentication.
@@ -3420,6 +3432,7 @@ export declare class NeynarAPIClient {
      * @summary List conversations for a deployment
      *
      * @param {object} params
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). If provided, filters conversations to this deployment only.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations.
      * @param {string} params.name [optional]  - Kubernetes deployment name. If provided, filters conversations to this deployment only.
      * @param {boolean | null} params.includeDeleted [optional]  - Include deleted conversations in the response. Defaults to false.
@@ -3429,11 +3442,12 @@ export declare class NeynarAPIClient {
      * @example
      *
      * // Fill in the appropriate values
+     * const deploymentId =
      * const fid =
      * const name =
      * const includeDeleted =
      *
-     * client.listConversations({ fid, name, includeDeleted }).then(response => {
+     * client.listConversations({ deploymentId, fid, name, includeDeleted }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3441,6 +3455,7 @@ export declare class NeynarAPIClient {
      *
      */
     listConversations(params: {
+        deploymentId?: string;
         fid?: number | null;
         name?: string;
         includeDeleted?: boolean | null;
@@ -3451,8 +3466,9 @@ export declare class NeynarAPIClient {
      * @summary List deployment files
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      * @param {string} params.directory [optional]  - Directory path relative to gen/ (defaults to root)
      *
@@ -3461,12 +3477,13 @@ export declare class NeynarAPIClient {
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      * const directory =
      *
-     * client.listDeploymentFiles({ name, fid, namespace, directory }).then(response => {
+     * client.listDeploymentFiles({ deploymentId, fid, name, namespace, directory }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3474,8 +3491,9 @@ export declare class NeynarAPIClient {
      *
      */
     listDeploymentFiles(params: {
-        name: string;
+        deploymentId?: string;
         fid?: number | null;
+        name?: string;
         namespace?: string;
         directory?: string;
     }): Promise<ListDeploymentFiles200Response>;
@@ -3644,9 +3662,10 @@ export declare class NeynarAPIClient {
      * @summary Get Vercel deployment build logs
      *
      * @param {object} params
-     * @param {string} params.name  - Deployment name used to identify the Vercel project
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user
      * @param {string} params.namespace [optional]  - K8s Namespace name
+     * @param {string} params.name [optional]  - Deployment name used to identify the Vercel project. Required if deployment_id not provided.
      * @param {number} params.limit [optional]  - Maximum number of log events to return. Defaults to 100.
      *
      * @returns {Promise<VercelDeploymentLogs200Response>} A promise that resolves to a `VercelDeploymentLogs200Response` object.
@@ -3654,12 +3673,13 @@ export declare class NeynarAPIClient {
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
      * const namespace =
+     * const name =
      * const limit =
      *
-     * client.vercelDeploymentLogs({ name, fid, namespace, limit }).then(response => {
+     * client.vercelDeploymentLogs({ deploymentId, fid, namespace, name, limit }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3667,9 +3687,10 @@ export declare class NeynarAPIClient {
      *
      */
     vercelDeploymentLogs(params: {
-        name: string;
+        deploymentId?: string;
         fid?: number | null;
         namespace?: string;
+        name?: string;
         limit?: number;
     }): Promise<VercelDeploymentLogs200Response>;
     /**
@@ -3678,20 +3699,22 @@ export declare class NeynarAPIClient {
      * @summary Get Vercel deployment status
      *
      * @param {object} params
-     * @param {string} params.name  - Deployment name used to identify the Vercel project
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
      * @param {string} params.namespace [optional]  - K8s Namespace name
+     * @param {string} params.name [optional]  - Deployment name used to identify the Vercel project. Required if deployment_id not provided.
      *
      * @returns {Promise<VercelDeploymentStatus200Response>} A promise that resolves to a `VercelDeploymentStatus200Response` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
      * const namespace =
+     * const name =
      *
-     * client.vercelDeploymentStatus({ name, fid, namespace }).then(response => {
+     * client.vercelDeploymentStatus({ deploymentId, fid, namespace, name }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3699,9 +3722,10 @@ export declare class NeynarAPIClient {
      *
      */
     vercelDeploymentStatus(params: {
-        name: string;
+        deploymentId?: string;
         fid?: number | null;
         namespace?: string;
+        name?: string;
     }): Promise<VercelDeploymentStatus200Response>;
     /**
      * Fetch what FIDs and contracts a FID is subscribed to.

package/build/clients/NeynarAPIClient.js

@@ -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 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.
      *
      * @summary Delete deployment(s)
      *
@@ -3649,9 +3649,10 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Get messages in a conversation
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
      * @param {string} params.conversationId  - Conversation ID
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      * @param {boolean | null} params.includeDeleted [optional]  - Include deleted messages in the response. Defaults to false.
      *
@@ -3660,13 +3661,14 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
      * const conversationId =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      * const includeDeleted =
      *
-     * client.getConversationMessages({ name, conversationId, fid, namespace, includeDeleted }).then(response => {
+     * client.getConversationMessages({ conversationId, deploymentId, fid, name, namespace, includeDeleted }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3680,13 +3682,14 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetches info about a miniapp generator deployment by its 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.
      *
      * @summary Get deployment info
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      *
      * @returns {Promise<ListDeployments200ResponseInner>} A promise that resolves to a `ListDeployments200ResponseInner` object.
@@ -3694,11 +3697,12 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      *
-     * client.getDeployment({ name, fid, namespace }).then(response => {
+     * client.getDeployment({ deploymentId, fid, name, namespace }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3717,9 +3721,10 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Get deployment file contents
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
      * @param {string} params.filePath  - File path relative to gen/
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      *
      * @returns {Promise<GetDeploymentFile200Response>} A promise that resolves to a `GetDeploymentFile200Response` object.
@@ -3727,12 +3732,13 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
      * const filePath =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      *
-     * client.getDeploymentFile({ name, filePath, fid, namespace }).then(response => {
+     * client.getDeploymentFile({ filePath, deploymentId, fid, name, namespace }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3751,18 +3757,20 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Get dev status of a miniapp
      *
      * @param {object} params
-     * @param {string} params.namespace  - Kubernetes namespace name
-     * @param {string} params.name  - Kubernetes deployment name
+     * @param {string} params.deploymentId [optional]  - Deployment ID
+     * @param {string} params.namespace [optional]  - Kubernetes namespace name
+     * @param {string} params.name [optional]  - Kubernetes deployment name
      *
      * @returns {Promise<GetDevStatus200Response>} A promise that resolves to a `GetDevStatus200Response` object.
      *
      * @example
      *
      * // Fill in the appropriate values
+     * const deploymentId =
      * const namespace =
      * const name =
      *
-     * client.getDevStatus({ namespace, name }).then(response => {
+     * client.getDevStatus({ deploymentId, namespace, name }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3781,6 +3789,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary List conversations for a deployment
      *
      * @param {object} params
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). If provided, filters conversations to this deployment only.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user. Required for non-admin users. Studio admins can omit to query all conversations.
      * @param {string} params.name [optional]  - Kubernetes deployment name. If provided, filters conversations to this deployment only.
      * @param {boolean | null} params.includeDeleted [optional]  - Include deleted conversations in the response. Defaults to false.
@@ -3790,11 +3799,12 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
+     * const deploymentId =
      * const fid =
      * const name =
      * const includeDeleted =
      *
-     * client.listConversations({ fid, name, includeDeleted }).then(response => {
+     * client.listConversations({ deploymentId, fid, name, includeDeleted }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3813,8 +3823,9 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary List deployment files
      *
      * @param {object} params
-     * @param {string} params.name  - Kubernetes deployment name
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
+     * @param {string} params.name [optional]  - Kubernetes deployment name. Required if deployment_id not provided.
      * @param {string} params.namespace [optional]  - Optional Kubernetes namespace. If not provided, will query for the active namespace for the given FID.
      * @param {string} params.directory [optional]  - Directory path relative to gen/ (defaults to root)
      *
@@ -3823,12 +3834,13 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
+     * const name =
      * const namespace =
      * const directory =
      *
-     * client.listDeploymentFiles({ name, fid, namespace, directory }).then(response => {
+     * client.listDeploymentFiles({ deploymentId, fid, name, namespace, directory }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -4021,9 +4033,10 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Get Vercel deployment build logs
      *
      * @param {object} params
-     * @param {string} params.name  - Deployment name used to identify the Vercel project
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user
      * @param {string} params.namespace [optional]  - K8s Namespace name
+     * @param {string} params.name [optional]  - Deployment name used to identify the Vercel project. Required if deployment_id not provided.
      * @param {number} params.limit [optional]  - Maximum number of log events to return. Defaults to 100.
      *
      * @returns {Promise<VercelDeploymentLogs200Response>} A promise that resolves to a `VercelDeploymentLogs200Response` object.
@@ -4031,12 +4044,13 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
      * const namespace =
+     * const name =
      * const limit =
      *
-     * client.vercelDeploymentLogs({ name, fid, namespace, limit }).then(response => {
+     * client.vercelDeploymentLogs({ deploymentId, fid, namespace, name, limit }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -4055,20 +4069,22 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Get Vercel deployment status
      *
      * @param {object} params
-     * @param {string} params.name  - Deployment name used to identify the Vercel project
+     * @param {string} params.deploymentId [optional]  - Deployment ID (UUID). Required if name not provided.
      * @param {number | null} params.fid [optional]  - Farcaster ID of the user; if not provided, namespace must be provided
      * @param {string} params.namespace [optional]  - K8s Namespace name
+     * @param {string} params.name [optional]  - Deployment name used to identify the Vercel project. Required if deployment_id not provided.
      *
      * @returns {Promise<VercelDeploymentStatus200Response>} A promise that resolves to a `VercelDeploymentStatus200Response` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const name =
+     * const deploymentId =
      * const fid =
      * const namespace =
+     * const name =
      *
-     * client.vercelDeploymentStatus({ name, fid, namespace }).then(response => {
+     * client.vercelDeploymentStatus({ deploymentId, fid, namespace, name }).then(response => {
      *   console.log('response:', response);
      * });
      *

package/package.json

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