@neynar/nodejs-sdk 3.89.0 → 3.95.3

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 { AppHostGetEventEventEnum, AppHostGetEventResponse, AppHostPostEventResponse, AppHostUserStateResponse, AssociateDeployment200Response, AssociateDeploymentRequest, AuthorizationUrlResponse, BalanceResponse, BanListResponse, BanResponse, BestFriendsResponse, BlockListResponse, BulkCastsResponse, BulkFollowResponse, BulkUsersByAddressResponse, BulkUsersResponse, CastEmbedCrawlResponse, CastResponse, CastsMetricsResponse, CastsResponse, CastsSearchResponse, ChannelListResponse, ChannelMemberInviteListResponse, ChannelMemberListResponse, ChannelMemberRole, ChannelResponse, ChannelResponseBulk, ChannelSearchResponse, Conversation, ConversationSummary, CreateDeploymentRequest, DeleteDeployment200Response, DeleteDeploymentRequest, DeployFungibleFactoryEnum, DeployFungibleMetadataNsfwEnum, DeployFungibleNetworkEnum, DeployFungibleResponse, DeployToVercel200Response, DeployToVercelRequest, DeveloperManagedSigner, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FetchAllNotificationsTypeEnum, FetchAuthorizationUrlResponseTypeEnum, FetchBulkCastsSortTypeEnum, FetchBulkChannelsTypeEnum, FetchBulkUsersByEthOrSolAddressAddressTypesEnum, FetchCastMetricsIntervalEnum, FetchCastQuotes200Response, FetchCastQuotesTypeEnum, FetchCastReactionsTypesEnum, FetchFeedEmbedTypesEnum, FetchFeedFeedTypeEnum, FetchFeedFilterTypeEnum, FetchFeedForYouProviderEnum, FetchFrameCatalogCategoriesEnum, FetchFrameCatalogNetworksEnum, FetchFrameCatalogTimeWindowEnum, FetchFungibleTrades200Response, FetchFungibleTradesNetworkEnum, FetchFungibleTradesTimeWindowEnum, FetchRelevantFrames200Response, FetchRelevantFramesNetworksEnum, FetchRelevantFramesTimeWindowEnum, FetchRelevantFungibleOwnersNetworkEnum, FetchRepliesAndRecastsForUserFilterEnum, FetchSubscribedToForFidSubscriptionProviderEnum, FetchSubscribersForFidSubscriptionProviderEnum, FetchSubscriptionsForFidSubscriptionProviderEnum, FetchTrendingChannelsTimeWindowEnum, FetchTrendingFeedProviderEnum, FetchTrendingFeedTimeWindowEnum, FetchTrendingFungibles200Response, FetchTrendingFungiblesNetworkEnum, FetchTrendingFungiblesTimeWindowEnum, FetchUserBalanceNetworksEnum, FetchUserFollowersSortTypeEnum, FetchUserFollowingSortTypeEnum, FetchUserInteractions200Response, FetchUserInteractionsTypeEnum, FetchUserReactionsTypeEnum, FetchUserReciprocalFollowers200Response, FetchUserReciprocalFollowersSortTypeEnum, FnameAvailabilityResponse, FollowersResponse, FrameCatalogResponse, FrameNotificationTokens, FramePayTransactionReqBodyTransaction, FungiblesResponseSchema, GetConversationMessages200Response, GetDeploymentFile200Response, GetDeploymentLogs200Response, GetNotificationCampaignStats200Response, ListConversations200Response, ListDeploymentFiles200Response, ListDeployments200ResponseInner, LookupCastByHashOrUrlTypeEnum, LookupCastConversationFoldEnum, LookupCastConversationSortTypeEnum, LookupCastConversationTypeEnum, LookupChannelTypeEnum, MintNft200Response, MintNftRequest, MuteListResponse, MuteResponse, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, PromptDeploymentStreamRequest, ReactionType, ReactionsCastResponse, ReactionsResponse, RegisterSignedKeyForDeveloperManagedAuthAddress200Response, RegisterUserOnChainReqBodyPreRegistrationCallsInner, RegisterUserOnChainReqBodyRegistration, RegisterUserOnChainReqBodySignersInner, RegisterUserOnChainResponse, RegisterUserReqBodyMetadata, RegisterUserReqBodySigner, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SearchCastsSortTypeEnum, SearchFramesNetworksEnum, SendFrameNotificationsReqBodyFilters, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, SimulateNftMintNetworkEnum, SimulateNftMintResponse, StartApp200Response, StartAppRequest, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionsResponse, TransactionFrameConfig, TransactionFrameResponse, TransactionSendFungiblesRecipient, TransactionSendFungiblesReqBodyNetworkEnum, TransactionSendFungiblesResponse, TrendingChannelResponse, UpdateUserReqBodyLocation, UpdateUserReqBodyVerifiedAccounts, UploadImage200Response, UploadImageUrlRequest, UserFIDResponse, UserResponse, UserSearchResponse, UsersActiveChannelsResponse, UsersResponse, VercelDeploymentLogs200Response, VercelDeploymentStatus200Response, VerificationChainId, VerificationType, WebhookListResponse, WebhookPatchReqBodyActiveEnum, WebhookResponse, WebhookSubscriptionFilters } from '../api';
+import type { AppHostGetEventEventEnum, AppHostGetEventResponse, AppHostPostEventResponse, AppHostUserStateResponse, AssociateDeployment200Response, AssociateDeploymentRequest, AuthorizationUrlResponse, BalanceResponse, BanListResponse, BanResponse, BestFriendsResponse, BlockListResponse, BulkCastsResponse, BulkFollowResponse, BulkUsersByAddressResponse, BulkUsersResponse, CastEmbedCrawlResponse, CastResponse, CastsMetricsResponse, CastsResponse, CastsSearchResponse, ChannelListResponse, ChannelMemberInviteListResponse, ChannelMemberListResponse, ChannelMemberRole, ChannelResponse, ChannelResponseBulk, ChannelSearchResponse, Conversation, ConversationSummary, CreateDeploymentRequest, DeleteDeployment200Response, DeleteDeploymentRequest, DeployFungibleFactoryEnum, DeployFungibleMetadataNsfwEnum, DeployFungibleNetworkEnum, DeployFungibleResponse, DeployToVercel200Response, DeployToVercelRequest, DeveloperManagedSigner, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FetchAllNotificationsTypeEnum, FetchAuthorizationUrlResponseTypeEnum, FetchBulkCastsSortTypeEnum, FetchBulkChannelsTypeEnum, FetchBulkUsersByEthOrSolAddressAddressTypesEnum, FetchCastMetricsIntervalEnum, FetchCastQuotes200Response, FetchCastQuotesTypeEnum, FetchCastReactionsTypesEnum, FetchFeedEmbedTypesEnum, FetchFeedFeedTypeEnum, FetchFeedFilterTypeEnum, FetchFeedForYouProviderEnum, FetchFrameCatalogCategoriesEnum, FetchFrameCatalogNetworksEnum, FetchFrameCatalogTimeWindowEnum, FetchFungibleTrades200Response, FetchFungibleTradesNetworkEnum, FetchFungibleTradesTimeWindowEnum, FetchRelevantFrames200Response, FetchRelevantFramesNetworksEnum, FetchRelevantFramesTimeWindowEnum, FetchRelevantFungibleOwnersNetworkEnum, FetchRepliesAndRecastsForUserFilterEnum, FetchSubscribedToForFidSubscriptionProviderEnum, FetchSubscribersForFidSubscriptionProviderEnum, FetchSubscriptionsForFidSubscriptionProviderEnum, FetchTrendingChannelsTimeWindowEnum, FetchTrendingFeedProviderEnum, FetchTrendingFeedTimeWindowEnum, FetchTrendingFungibles200Response, FetchTrendingFungiblesNetworkEnum, FetchTrendingFungiblesTimeWindowEnum, FetchUserBalanceNetworksEnum, FetchUserFollowersSortTypeEnum, FetchUserFollowingSortTypeEnum, FetchUserInteractions200Response, FetchUserInteractionsTypeEnum, FetchUserReactionsTypeEnum, FetchUserReciprocalFollowers200Response, FetchUserReciprocalFollowersSortTypeEnum, FetchVerifications200Response, FnameAvailabilityResponse, FollowersResponse, FrameCatalogResponse, FrameNotificationTokens, FramePayTransactionReqBodyTransaction, FungiblesResponseSchema, GetConversationMessages200Response, GetDeploymentFile200Response, GetDeploymentLogs200Response, GetNotificationCampaignStats200Response, ListConversations200Response, ListDeploymentFiles200Response, ListDeployments200ResponseInner, LookupCastByHashOrUrlTypeEnum, LookupCastConversationFoldEnum, LookupCastConversationSortTypeEnum, LookupCastConversationTypeEnum, LookupChannelTypeEnum, MintNft200Response, MintNftRequest, MuteListResponse, MuteResponse, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, PromptDeploymentStreamRequest, ReactionType, ReactionsCastResponse, ReactionsResponse, RegisterSignedKeyForDeveloperManagedAuthAddress200Response, RegisterUserOnChainReqBodyPreRegistrationCallsInner, RegisterUserOnChainReqBodyRegistration, RegisterUserOnChainReqBodySignersInner, RegisterUserOnChainResponse, RegisterUserReqBodyMetadata, RegisterUserReqBodySigner, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SearchCastsSortTypeEnum, SearchFramesNetworksEnum, SendFrameNotificationsReqBodyFilters, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, SimulateNftMintNetworkEnum, SimulateNftMintResponse, StartApp200Response, StartAppRequest, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionsResponse, TransactionFrameConfig, TransactionFrameResponse, TransactionSendFungiblesRecipient, TransactionSendFungiblesReqBodyNetworkEnum, TransactionSendFungiblesResponse, TrendingChannelResponse, TrendingTopicsResponse, UpdateUserReqBodyLocation, UpdateUserReqBodyVerifiedAccounts, UploadImage200Response, UploadImageUrlRequest, UserFIDResponse, UserResponse, UserSearchResponse, UsersActiveChannelsResponse, UsersResponse, VercelDeploymentLogs200Response, VercelDeploymentStatus200Response, VerificationChainId, VerificationType, WebhookListResponse, WebhookPatchReqBodyActiveEnum, WebhookResponse, WebhookSubscriptionFilters } from '../api';
 export interface NeynarAPIClientOptions {
     logger?: Logger;
     axiosInstance?: AxiosInstance;
@@ -1317,7 +1317,7 @@ export declare class NeynarAPIClient {
      *
      * @param {object} params
      * @param {FetchFeedFeedTypeEnum} params.feedType [optional]  - Defaults to following (requires FID or address). If set to filter (requires filter_type)
-     * @param {FetchFeedFilterTypeEnum} params.filterType [optional]  - Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id)
+     * @param {FetchFeedFilterTypeEnum} params.filterType [optional]  - Used when feed_type=filter. Options include fids (requires fids), parent_url (requires parent_url), channel_id (requires channel_id), embed_url (requires embed_url), embed_types (requires embed_types), or global_trending.
      * @param {number} params.fid [optional]  - (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type
      * @param {number[]} params.fids [optional]  - Used when filter_type=FIDs . Create a feed based on a list of FIDs. Max array size is 100. Requires feed_type and filter_type.
      * @param {string} params.parentUrl [optional]  - Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type.
@@ -1457,6 +1457,42 @@ export declare class NeynarAPIClient {
         limit?: number;
         cursor?: string;
     }): Promise<FeedResponse>;
+    /**
+     * Fetch feed based on a topic slug.
+     *
+     * @summary By topic
+     *
+     * @param {object} params
+     * @param {string} params.slug  - Topic slug to filter casts by. Must be lowercase and contain only alphanumeric characters and underscores.
+     * @param {boolean | null} params.withRecasts [optional]  - Include recasts in the response, true by default.
+     * @param {number} params.viewerFid [optional]  - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
+     * @param {number} params.limit [optional]  - Number of results to fetch. (Default: 25, Maximum: 100)
+     * @param {string} params.cursor [optional]  - Pagination cursor.
+     *
+     * @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const slug =
+     * const withRecasts =
+     * const viewerFid =
+     * const limit =
+     *
+     * client.fetchFeedByTopic({ slug, withRecasts, viewerFid, limit }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-feed-by-topic)
+     *
+     */
+    fetchFeedByTopic(params: {
+        slug: string;
+        withRecasts?: boolean | null;
+        viewerFid?: number;
+        limit?: number;
+        cursor?: string;
+    }): Promise<FeedResponse>;
     /**
      * Fetch a personalized For You feed for a user
      *
@@ -3717,6 +3753,33 @@ export declare class NeynarAPIClient {
         fid: number;
         subscriptionProvider: FetchSubscriptionsForFidSubscriptionProviderEnum;
     }): Promise<SubscriptionsResponse>;
+    /**
+     * Returns a list of trending topics for casts.
+     *
+     * @summary Fetch trending topics
+     *
+     * @param {object} params
+     * @param {number} params.limit [optional]  - Number of topics to fetch. (Default: 10, Maximum: 25)
+     * @param {string} params.cursor [optional]  - Pagination cursor.
+     *
+     * @returns {Promise<TrendingTopicsResponse>} A promise that resolves to a `TrendingTopicsResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const limit =
+     *
+     * client.listTrendingTopics({ limit }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-trending-topics)
+     *
+     */
+    listTrendingTopics(params: {
+        limit?: number;
+        cursor?: string;
+    }): Promise<TrendingTopicsResponse>;
     /**
      * Removes verification for an eth address for the user  (In order to delete verification `signer_uuid` must be approved)
      *
@@ -3846,6 +3909,31 @@ export declare class NeynarAPIClient {
         limit?: number;
         cursor?: string;
     }): Promise<UsersResponse>;
+    /**
+     * Fetch all Ethereum and Solana verified addresses for a farcaster user
+     *
+     * @summary Fetch verifications
+     *
+     * @param {object} params
+     * @param {number | null} params.fid  - FID of the user whose verifications to fetch
+     *
+     * @returns {Promise<FetchVerifications200Response>} A promise that resolves to a `FetchVerifications200Response` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const fid =
+     *
+     * client.fetchVerifications({ fid }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-verifications)
+     *
+     */
+    fetchVerifications(params: {
+        fid: number | null;
+    }): Promise<FetchVerifications200Response>;
     /**
      * Follow a user  (In order to follow a user `signer_uuid` must be approved)
      *

package/build/clients/NeynarAPIClient.js

@@ -52,6 +52,7 @@ const signer_api_1 = require("../api/apis/signer-api");
 const storage_api_1 = require("../api/apis/storage-api");
 const studio_api_1 = require("../api/apis/studio-api");
 const subscribers_api_1 = require("../api/apis/subscribers-api");
+const topic_api_1 = require("../api/apis/topic-api");
 const user_api_1 = require("../api/apis/user-api");
 const webhook_api_1 = require("../api/apis/webhook-api");
 const { version: sdkVersion } = require("../../package.json");
@@ -163,6 +164,7 @@ const client = new NeynarAPIClient(config);\n`);
             storageApi: new storage_api_1.StorageApi(this.config, undefined, axiosInstance),
             studioApi: new studio_api_1.StudioApi(this.config, undefined, axiosInstance),
             subscribersApi: new subscribers_api_1.SubscribersApi(this.config, undefined, axiosInstance),
+            topicApi: new topic_api_1.TopicApi(this.config, undefined, axiosInstance),
             userApi: new user_api_1.UserApi(this.config, undefined, axiosInstance),
             webhookApi: new webhook_api_1.WebhookApi(this.config, undefined, axiosInstance),
         };
@@ -1552,7 +1554,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {FetchFeedFeedTypeEnum} params.feedType [optional]  - Defaults to following (requires FID or address). If set to filter (requires filter_type)
-     * @param {FetchFeedFilterTypeEnum} params.filterType [optional]  - Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id)
+     * @param {FetchFeedFilterTypeEnum} params.filterType [optional]  - Used when feed_type=filter. Options include fids (requires fids), parent_url (requires parent_url), channel_id (requires channel_id), embed_url (requires embed_url), embed_types (requires embed_types), or global_trending.
      * @param {number} params.fid [optional]  - (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type
      * @param {number[]} params.fids [optional]  - Used when filter_type=FIDs . Create a feed based on a list of FIDs. Max array size is 100. Requires feed_type and filter_type.
      * @param {string} params.parentUrl [optional]  - Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type.
@@ -1700,6 +1702,43 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.feedApi.fetchFeedByParentUrls(adjustedParams);
         return response.data;
     }
+    /**
+     * Fetch feed based on a topic slug.
+     *
+     * @summary By topic
+     *
+     * @param {object} params
+     * @param {string} params.slug  - Topic slug to filter casts by. Must be lowercase and contain only alphanumeric characters and underscores.
+     * @param {boolean | null} params.withRecasts [optional]  - Include recasts in the response, true by default.
+     * @param {number} params.viewerFid [optional]  - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
+     * @param {number} params.limit [optional]  - Number of results to fetch. (Default: 25, Maximum: 100)
+     * @param {string} params.cursor [optional]  - Pagination cursor.
+     *
+     * @returns {Promise<FeedResponse>} A promise that resolves to a `FeedResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const slug =
+     * const withRecasts =
+     * const viewerFid =
+     * const limit =
+     *
+     * client.fetchFeedByTopic({ slug, withRecasts, viewerFid, limit }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-feed-by-topic)
+     *
+     */
+    async fetchFeedByTopic(params) {
+        var _a, _b;
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
+        const response = await this.apis.feedApi.fetchFeedByTopic(adjustedParams);
+        return response.data;
+    }
     /**
      * Fetch a personalized For You feed for a user
      *
@@ -4095,6 +4134,35 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.subscribersApi.fetchSubscriptionsForFid(adjustedParams);
         return response.data;
     }
+    /**
+     * Returns a list of trending topics for casts.
+     *
+     * @summary Fetch trending topics
+     *
+     * @param {object} params
+     * @param {number} params.limit [optional]  - Number of topics to fetch. (Default: 10, Maximum: 25)
+     * @param {string} params.cursor [optional]  - Pagination cursor.
+     *
+     * @returns {Promise<TrendingTopicsResponse>} A promise that resolves to a `TrendingTopicsResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const limit =
+     *
+     * client.listTrendingTopics({ limit }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/list-trending-topics)
+     *
+     */
+    async listTrendingTopics(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.topicApi.listTrendingTopics(adjustedParams);
+        return response.data;
+    }
     /**
      * Removes verification for an eth address for the user  (In order to delete verification `signer_uuid` must be approved)
      *
@@ -4242,6 +4310,34 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.userApi.fetchUsersByLocation(adjustedParams);
         return response.data;
     }
+    /**
+     * Fetch all Ethereum and Solana verified addresses for a farcaster user
+     *
+     * @summary Fetch verifications
+     *
+     * @param {object} params
+     * @param {number | null} params.fid  - FID of the user whose verifications to fetch
+     *
+     * @returns {Promise<FetchVerifications200Response>} A promise that resolves to a `FetchVerifications200Response` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const fid =
+     *
+     * client.fetchVerifications({ fid }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-verifications)
+     *
+     */
+    async fetchVerifications(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.userApi.fetchVerifications(adjustedParams);
+        return response.data;
+    }
     /**
      * Follow a user  (In order to follow a user `signer_uuid` must be approved)
      *

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "@neynar/nodejs-sdk",
-  "version": "3.89.0",
+  "version": "3.95.3",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/neynarxyz/nodejs-sdk.git"
+  },
   "description": "SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",