@neynar/nodejs-sdk 2.13.1 → 2.17.0

package/build/clients/NeynarAPIClient.js

@@ -31,6 +31,7 @@ const configuration_1 = require("../api/configuration");
 const constants_1 = require("../common/constants");
 const utils_1 = require("../utils");
 const action_api_1 = require("../api/apis/action-api");
+const agents_api_1 = require("../api/apis/agents-api");
 const ban_api_1 = require("../api/apis/ban-api");
 const block_api_1 = require("../api/apis/block-api");
 const cast_api_1 = require("../api/apis/cast-api");
@@ -138,6 +139,7 @@ const client = new NeynarAPIClient(config);\n`);
         });
         this.apis = {
             actionApi: new action_api_1.ActionApi(this.config, undefined, axiosInstance),
+            agentsApi: new agents_api_1.AgentsApi(this.config, undefined, axiosInstance),
             banApi: new ban_api_1.BanApi(this.config, undefined, axiosInstance),
             blockApi: new block_api_1.BlockApi(this.config, undefined, axiosInstance),
             castApi: new cast_api_1.CastApi(this.config, undefined, axiosInstance),
@@ -198,6 +200,71 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.actionApi.publishFarcasterAction(adjustedParams);
         return response.data;
     }
+    /**
+     * Returns a list of interactions between two users
+     *
+     * @summary User interactions
+     *
+     * @param {object} params
+     * @param {number[]} params.fids  - Comma separated list of two FIDs
+     * @param {Array<NotificationType>} params.type [optional]  - Comma seperated list of Interaction type to fetch
+     *
+     * @returns {Promise<FetchUserInteractions200Response>} A promise that resolves to a `FetchUserInteractions200Response` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const fids =
+     * const type =
+     *
+     * client.fetchUserInteractions({ fids, type }).then(response => {
+     *   console.log('response:', response);
+     * });
+     */
+    async fetchUserInteractions(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        if (adjustedParams.fids && Array.isArray(adjustedParams.fids)) {
+            adjustedParams.fids = adjustedParams.fids.map(value => (String(value)));
+        }
+        if (adjustedParams.fids && Array.isArray(adjustedParams.fids)) {
+            adjustedParams.fids = adjustedParams.fids.join(",");
+        }
+        const response = await this.apis.agentsApi.fetchUserInteractions(adjustedParams);
+        return response.data;
+    }
+    /**
+     * Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL.  Summary is generated by an LLM and is intended to be passed as a context to AI agents.
+     *
+     * @summary Conversation summary for a cast
+     *
+     * @param {object} params
+     * @param {string} params.identifier  - Cast identifier (Its either a url or a hash)
+     * @param {number} params.limit [optional]  - Number of casts to consider in a summary up to a point of target cast (Default: 20, Maximum: 50)
+     * @param {string} params.prompt [optional]  - Additional prompt used to generate a summary
+     *
+     * @returns {Promise<ConversationSummary>} A promise that resolves to a `ConversationSummary` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const identifier =
+     * const limit =
+     * const prompt =
+     *
+     * client.lookupCastConversationSummary({ identifier, limit, prompt }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-cast-conversation-summary)
+     *
+     */
+    async lookupCastConversationSummary(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.agentsApi.lookupCastConversationSummary(adjustedParams);
+        return response.data;
+    }
     /**
      * Deletes a list of FIDs from the app associated with your API key.
      *
@@ -584,38 +651,6 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.castApi.lookupCastConversation(adjustedParams);
         return response.data;
     }
-    /**
-     * Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL.  Summary is generated by an LLM and is intended to be passed as a context to AI agents.
-     *
-     * @summary Conversation summary for a cast
-     *
-     * @param {object} params
-     * @param {string} params.identifier  - Cast identifier (Its either a url or a hash)
-     * @param {number} params.limit [optional]  - Number of casts to consider in a summary up to a point of target cast (Default: 20, Maximum: 50)
-     * @param {string} params.prompt [optional]  - Additional prompt used to generate a summary
-     *
-     * @returns {Promise<ConversationSummary>} A promise that resolves to a `ConversationSummary` object.
-     *
-     * @example
-     *
-     * // Fill in the appropriate values
-     * const identifier =
-     * const limit =
-     * const prompt =
-     *
-     * client.lookupCastConversationSummary({ identifier, limit, prompt }).then(response => {
-     *   console.log('response:', response);
-     * });
-     *
-     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-cast-conversation-summary)
-     *
-     */
-    async lookupCastConversationSummary(params) {
-        const adjustedParams = {};
-        Object.assign(adjustedParams, params);
-        const response = await this.apis.castApi.lookupCastConversationSummary(adjustedParams);
-        return response.data;
-    }
     /**
      * Posts a cast or cast reply. Works with mentions and embeds.   (In order to post a cast `signer_uuid` must be approved)
      *
@@ -664,6 +699,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {string} params.q  - Query string to search for casts. Include 'before:YYYY-MM-DD' or 'after:YYYY-MM-DD' to search for casts before or after a specific date.
+     * @param {SearchCastsModeEnum} params.mode [optional]  - Choices are `literal` (default), `semantic`, `hybrid`
      * @param {number} params.authorFid [optional]  - Fid of the user whose casts you want to search
      * @param {number} params.viewerFid [optional]  - Providing this will return search results that respects this user's mutes and blocks and includes `viewer_context`.
      * @param {string} params.parentUrl [optional]  - Parent URL of the casts you want to search
@@ -678,6 +714,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * // Fill in the appropriate values
      * const q =
+     * const mode =
      * const authorFid =
      * const viewerFid =
      * const parentUrl =
@@ -685,7 +722,7 @@ const client = new NeynarAPIClient(config);\n`);
      * const priorityMode =
      * const limit =
      *
-     * client.searchCasts({ q, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit }).then(response => {
+     * client.searchCasts({ q, mode, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -1258,6 +1295,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {number} params.fid  - FID of user whose recent casts you want to fetch
+     * @param {number} params.appFid [optional]  - Optionally filter to casts created via a specific app FID, e.g. 9152 for Warpcast
      * @param {number} params.viewerFid [optional]  - FID of the user viewing the feed
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 25, Maximum: 150)
      * @param {string} params.cursor [optional]  - Pagination cursor
@@ -1271,13 +1309,14 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * // Fill in the appropriate values
      * const fid =
+     * const appFid =
      * const viewerFid =
      * const limit =
      * const includeReplies =
      * const parentUrl =
      * const channelId =
      *
-     * client.fetchCastsForUser({ fid, viewerFid, limit, includeReplies, parentUrl, channelId }).then(response => {
+     * client.fetchCastsForUser({ fid, appFid, viewerFid, limit, includeReplies, parentUrl, channelId }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -1772,9 +1811,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch a list of users followed by a user. Can optionally include a viewer_fid and sort_type.
+     * Fetch a list of users who a given user is following. Can optionally include a viewer_fid and sort_type.
      *
-     * @summary Followed by
+     * @summary Following
      *
      * @param {object} params
      * @param {number} params.fid  - FID of the user whose following you want to fetch.
@@ -1920,6 +1959,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 20, Maximum: 100)
      * @param {number[]} params.fids [optional]  - Comma separated list of FIDs, up to 100 at a time
+     * @param {string} params.cursor [optional]  - Pagination cursor
      *
      * @returns {Promise<FrameNotificationTokens>} A promise that resolves to a `FrameNotificationTokens` object.
      *
@@ -2394,6 +2434,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {number} params.fid  - FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.
      * @param {Array<NotificationType>} params.type [optional]  - Notification type to fetch. Comma separated values of follows, recasts, likes, mentions, replies.
      * @param {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided).
+     * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *
      * @returns {Promise<NotificationsResponse>} A promise that resolves to a `NotificationsResponse` object.
@@ -2404,8 +2445,9 @@ const client = new NeynarAPIClient(config);\n`);
      * const fid =
      * const type =
      * const priorityMode =
+     * const limit =
      *
-     * client.fetchAllNotifications({ fid, type, priorityMode }).then(response => {
+     * client.fetchAllNotifications({ fid, type, priorityMode, limit }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2427,6 +2469,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {number} params.fid  - FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.
      * @param {string[]} params.channelIds  - Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels)
      * @param {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided).
+     * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *
      * @returns {Promise<NotificationsResponse>} A promise that resolves to a `NotificationsResponse` object.
@@ -2437,8 +2480,9 @@ const client = new NeynarAPIClient(config);\n`);
      * const fid =
      * const channelIds =
      * const priorityMode =
+     * const limit =
      *
-     * client.fetchChannelNotificationsForUser({ fid, channelIds, priorityMode }).then(response => {
+     * client.fetchChannelNotificationsForUser({ fid, channelIds, priorityMode, limit }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2463,6 +2507,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {number} params.fid  - FID of the user you you want to fetch notifications for. The response will respect this user's mutes and blocks.
      * @param {string[]} params.parentUrls  - Comma separated parent_urls
      * @param {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided).
+     * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *
      * @returns {Promise<NotificationsResponse>} A promise that resolves to a `NotificationsResponse` object.
@@ -2473,8 +2518,9 @@ const client = new NeynarAPIClient(config);\n`);
      * const fid =
      * const parentUrls =
      * const priorityMode =
+     * const limit =
      *
-     * client.fetchNotificationsByParentUrlForUser({ fid, parentUrls, priorityMode }).then(response => {
+     * client.fetchNotificationsByParentUrlForUser({ fid, parentUrls, priorityMode, limit }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3406,39 +3452,6 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.userApi.fetchPowerUsersLite(adjustedParams);
         return response.data;
     }
-    /**
-     * Returns a list of interactions between two users
-     *
-     * @summary User interactions
-     *
-     * @param {object} params
-     * @param {number[]} params.fids  - Comma separated list of two FIDs
-     * @param {Array<NotificationType>} params.type [optional]  - Comma seperated list of Interaction type to fetch
-     *
-     * @returns {Promise<FetchUserInteractions200Response>} A promise that resolves to a `FetchUserInteractions200Response` object.
-     *
-     * @example
-     *
-     * // Fill in the appropriate values
-     * const fids =
-     * const type =
-     *
-     * client.fetchUserInteractions({ fids, type }).then(response => {
-     *   console.log('response:', response);
-     * });
-     */
-    async fetchUserInteractions(params) {
-        const adjustedParams = {};
-        Object.assign(adjustedParams, params);
-        if (adjustedParams.fids && Array.isArray(adjustedParams.fids)) {
-            adjustedParams.fids = adjustedParams.fids.map(value => (String(value)));
-        }
-        if (adjustedParams.fids && Array.isArray(adjustedParams.fids)) {
-            adjustedParams.fids = adjustedParams.fids.join(",");
-        }
-        const response = await this.apis.userApi.fetchUserInteractions(adjustedParams);
-        return response.data;
-    }
     /**
      * Fetches a list of users given a location
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neynar/nodejs-sdk",
-  "version": "2.13.1",
+  "version": "2.17.0",
   "description": "SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",