@neynar/nodejs-sdk 2.13.1 → 2.17.0

package/build/api/models/webhook-subscription-filters.js

@@ -5,7 +5,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/webhook-subscription.d.ts

@@ -2,7 +2,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/webhook-subscription.js

@@ -5,7 +5,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/webhook.d.ts

@@ -2,7 +2,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/webhook.js

@@ -5,7 +5,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/zod-error-errors-inner.d.ts

@@ -2,7 +2,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/zod-error-errors-inner.js

@@ -5,7 +5,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/zod-error.d.ts

@@ -2,7 +2,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/models/zod-error.js

@@ -5,7 +5,7 @@
  * Farcaster API V2
  * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.13.1
+ * The version of the OpenAPI document: 2.17.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/clients/NeynarAPIClient.d.ts

@@ -2,7 +2,7 @@ import { Logger } from "../common/logger";
 import { AxiosError, AxiosInstance } from "axios";
 import type { SetRequired } from "type-fest";
 import { Configuration } from './configuration';
-import type { AuthorizationUrlResponse, AuthorizationUrlResponseType, BalanceResponse, BanListResponse, BanResponse, BlockListResponse, BulkCastsResponse, BulkFollowResponse, BulkUserAddressType, BulkUsersByAddressResponse, BulkUsersResponse, CastComposerActionsListResponse, CastComposerType, CastConversationSortType, CastEmbedCrawlResponse, CastParamType, CastResponse, CastsMetricsResponse, CastsResponse, CastsSearchResponse, ChannelListResponse, ChannelMemberInviteListResponse, ChannelMemberListResponse, ChannelMemberRole, ChannelResponse, ChannelResponseBulk, ChannelSearchResponse, ChannelType, Conversation, ConversationSummary, DeleteFrameResponse, DeployFungibleFactoryEnum, DeployFungibleMetadataNsfwEnum, DeployFungibleNetworkEnum, DeployFungibleReqBodyMetadataMedia, DeployFungibleResponse, DeveloperManagedSigner, EmbedType, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FeedTrendingProvider, FeedType, FetchBulkCastsSortTypeEnum, FetchCastMetricsIntervalEnum, FetchFrameMetaTagsFromUrl200Response, FetchRepliesAndRecastsForUserFilterEnum, FetchTrendingChannelsTimeWindowEnum, FetchTrendingFeedTimeWindowEnum, FetchUserInteractions200Response, FilterType, FnameAvailabilityResponse, FollowSortType, FollowersResponse, ForYouProvider, Frame, FrameAction, FrameCatalogResponse, FrameNotificationTokens, FrameSignaturePacket, FrameType, FrameValidateAnalyticsResponse, FrameValidateListResponse, LookupCastConversationFoldEnum, MuteListResponse, MuteResponse, Networks, NeynarFrame, NeynarFramePage, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, ReactionType, ReactionsCastResponse, ReactionsResponse, ReactionsType, RegisterUserReqBodyMetadata, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionProvider, SubscriptionProviders, SubscriptionsResponse, TrendingChannelResponse, UpdateUserReqBodyLocation, UpdateUserReqBodyVerifiedAccounts, UserFIDResponse, UserPowerLiteResponse, UserResponse, UserSearchResponse, UsersActiveChannelsResponse, UsersResponse, ValidateFrameActionResponse, ValidateFrameAggregateWindow, ValidateFrameAnalyticsType, VerificationChainId, VerificationType, WebhookListResponse, WebhookPatchReqBodyActiveEnum, WebhookResponse, WebhookSubscriptionFilters } from '../api';
+import type { AuthorizationUrlResponse, AuthorizationUrlResponseType, BalanceResponse, BanListResponse, BanResponse, BlockListResponse, BulkCastsResponse, BulkFollowResponse, BulkUserAddressType, BulkUsersByAddressResponse, BulkUsersResponse, CastComposerActionsListResponse, CastComposerType, CastConversationSortType, CastEmbedCrawlResponse, CastParamType, CastResponse, CastsMetricsResponse, CastsResponse, CastsSearchResponse, ChannelListResponse, ChannelMemberInviteListResponse, ChannelMemberListResponse, ChannelMemberRole, ChannelResponse, ChannelResponseBulk, ChannelSearchResponse, ChannelType, Conversation, ConversationSummary, DeleteFrameResponse, DeployFungibleFactoryEnum, DeployFungibleMetadataNsfwEnum, DeployFungibleNetworkEnum, DeployFungibleReqBodyMetadataMedia, DeployFungibleResponse, DeveloperManagedSigner, EmbedType, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FeedTrendingProvider, FeedType, FetchBulkCastsSortTypeEnum, FetchCastMetricsIntervalEnum, FetchFrameMetaTagsFromUrl200Response, FetchRepliesAndRecastsForUserFilterEnum, FetchTrendingChannelsTimeWindowEnum, FetchTrendingFeedTimeWindowEnum, FetchUserInteractions200Response, FilterType, FnameAvailabilityResponse, FollowSortType, FollowersResponse, ForYouProvider, Frame, FrameAction, FrameCatalogResponse, FrameNotificationTokens, FrameSignaturePacket, FrameType, FrameValidateAnalyticsResponse, FrameValidateListResponse, LookupCastConversationFoldEnum, MuteListResponse, MuteResponse, Networks, NeynarFrame, NeynarFramePage, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, ReactionType, ReactionsCastResponse, ReactionsResponse, ReactionsType, RegisterUserReqBodyMetadata, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionProvider, SubscriptionProviders, SubscriptionsResponse, TrendingChannelResponse, UpdateUserReqBodyLocation, UpdateUserReqBodyVerifiedAccounts, UserFIDResponse, UserPowerLiteResponse, UserResponse, UserSearchResponse, UsersActiveChannelsResponse, UsersResponse, ValidateFrameActionResponse, ValidateFrameAggregateWindow, ValidateFrameAnalyticsType, VerificationChainId, VerificationType, WebhookListResponse, WebhookPatchReqBodyActiveEnum, WebhookResponse, WebhookSubscriptionFilters } from '../api';
 export interface NeynarAPIClientOptions {
     logger?: Logger;
     axiosInstance?: AxiosInstance;
@@ -46,6 +46,62 @@ export declare class NeynarAPIClient {
     }): Promise<{
         [key: string]: any;
     }>;
+    /**
+     * 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);
+     * });
+     */
+    fetchUserInteractions(params: {
+        fids: number[];
+        type?: Array<NotificationType>;
+    }): Promise<FetchUserInteractions200Response>;
+    /**
+     * 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)
+     *
+     */
+    lookupCastConversationSummary(params: {
+        identifier: string;
+        limit?: number;
+        prompt?: string;
+    }): Promise<ConversationSummary>;
     /**
      * Deletes a list of FIDs from the app associated with your API key.
      *
@@ -405,37 +461,6 @@ export declare class NeynarAPIClient {
         limit?: number;
         cursor?: string;
     }): Promise<Conversation>;
-    /**
-     * 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)
-     *
-     */
-    lookupCastConversationSummary(params: {
-        identifier: string;
-        limit?: number;
-        prompt?: string;
-    }): Promise<ConversationSummary>;
     /**
      * Posts a cast or cast reply. Works with mentions and embeds.   (In order to post a cast `signer_uuid` must be approved)
      *
@@ -486,6 +511,7 @@ export declare class NeynarAPIClient {
      *
      * @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
@@ -500,6 +526,7 @@ export declare class NeynarAPIClient {
      *
      * // Fill in the appropriate values
      * const q =
+     * const mode =
      * const authorFid =
      * const viewerFid =
      * const parentUrl =
@@ -507,7 +534,7 @@ export declare class NeynarAPIClient {
      * 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);
      * });
      *
@@ -516,6 +543,7 @@ export declare class NeynarAPIClient {
      */
     searchCasts(params: {
         q: string;
+        mode?: SearchCastsModeEnum;
         authorFid?: number;
         viewerFid?: number;
         parentUrl?: string;
@@ -1055,6 +1083,7 @@ export declare class NeynarAPIClient {
      *
      * @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
@@ -1068,13 +1097,14 @@ export declare class NeynarAPIClient {
      *
      * // 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);
      * });
      *
@@ -1083,6 +1113,7 @@ export declare class NeynarAPIClient {
      */
     fetchCastsForUser(params: {
         fid: number;
+        appFid?: number;
         viewerFid?: number;
         limit?: number;
         cursor?: string;
@@ -1569,9 +1600,9 @@ export declare class NeynarAPIClient {
         cursor?: string;
     }): Promise<FollowersResponse>;
     /**
-     * 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.
@@ -1704,6 +1735,7 @@ export declare class NeynarAPIClient {
      * @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.
      *
@@ -1723,6 +1755,7 @@ export declare class NeynarAPIClient {
     fetchNotificationTokens(params: {
         limit?: number;
         fids?: number[];
+        cursor?: string;
     }): Promise<FrameNotificationTokens>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
@@ -2143,6 +2176,7 @@ export declare class NeynarAPIClient {
      * @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.
@@ -2153,8 +2187,9 @@ export declare class NeynarAPIClient {
      * 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);
      * });
      *
@@ -2165,6 +2200,7 @@ export declare class NeynarAPIClient {
         fid: number;
         type?: Array<NotificationType>;
         priorityMode?: boolean;
+        limit?: number;
         cursor?: string;
     }): Promise<NotificationsResponse>;
     /**
@@ -2176,6 +2212,7 @@ export declare class NeynarAPIClient {
      * @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.
@@ -2186,8 +2223,9 @@ export declare class NeynarAPIClient {
      * 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);
      * });
      *
@@ -2198,6 +2236,7 @@ export declare class NeynarAPIClient {
         fid: number;
         channelIds: string[];
         priorityMode?: boolean;
+        limit?: number;
         cursor?: string;
     }): Promise<NotificationsResponse>;
     /**
@@ -2209,6 +2248,7 @@ export declare class NeynarAPIClient {
      * @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.
@@ -2219,8 +2259,9 @@ export declare class NeynarAPIClient {
      * 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);
      * });
      *
@@ -2231,6 +2272,7 @@ export declare class NeynarAPIClient {
         fid: number;
         parentUrls: string[];
         priorityMode?: boolean;
+        limit?: number;
         cursor?: string;
     }): Promise<NotificationsResponse>;
     /**
@@ -3096,31 +3138,6 @@ export declare class NeynarAPIClient {
      *
      */
     fetchPowerUsersLite(): Promise<UserPowerLiteResponse>;
-    /**
-     * 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);
-     * });
-     */
-    fetchUserInteractions(params: {
-        fids: number[];
-        type?: Array<NotificationType>;
-    }): Promise<FetchUserInteractions200Response>;
     /**
      * Fetches a list of users given a location
      *