@neynar/nodejs-sdk 2.38.0 → 2.41.0

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, DeployFungibleResponse, DeveloperManagedSigner, EmbedType, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FeedTrendingProvider, FeedType, FetchBulkCastsSortTypeEnum, FetchCastMetricsIntervalEnum, FetchFrameCatalogCategoriesEnum, FetchFrameMetaTagsFromUrl200Response, FetchRelevantFrames200Response, FetchRepliesAndRecastsForUserFilterEnum, FetchTrendingChannelsTimeWindowEnum, FetchUserInteractions200Response, FilterType, FnameAvailabilityResponse, FollowSortType, FollowersResponse, ForYouProvider, Frame, FrameAction, FrameCatalogResponse, FrameNotificationTokens, FramePayTransactionRequestBody, FrameSignaturePacket, FrameType, FrameValidateAnalyticsResponse, FrameValidateListResponse, LookupCastConversationFoldEnum, MuteListResponse, MuteResponse, Networks, NeynarFrame, NeynarFramePage, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, ReactionType, ReactionsCastResponse, ReactionsResponse, ReactionsType, RegisterUserOnChainReqBodyRegistration, RegisterUserOnChainReqBodySignersInner, RegisterUserOnChainResponse, RegisterUserReqBodyMetadata, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SearchSortType, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionProvider, SubscriptionProviders, SubscriptionsResponse, TransactionFrameResponse, TrendingChannelResponse, TrendingTimeWindow, 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, DeployFungibleResponse, DeveloperManagedSigner, EmbedType, ErrorRes, FarcasterActionReqBodyAction, FeedResponse, FeedTrendingProvider, FeedType, FetchBulkCastsSortTypeEnum, FetchCastMetricsIntervalEnum, FetchFrameCatalogCategoriesEnum, FetchFrameMetaTagsFromUrl200Response, FetchRelevantFrames200Response, FetchRepliesAndRecastsForUserFilterEnum, FetchTrendingChannelsTimeWindowEnum, FetchUserInteractions200Response, FilterType, FnameAvailabilityResponse, FollowSortType, FollowersResponse, ForYouProvider, Frame, FrameAction, FrameCatalogResponse, FrameNotificationTokens, FramePayTransactionRequestBody, FrameSignaturePacket, FrameType, FrameValidateAnalyticsResponse, FrameValidateListResponse, LookupCastConversationFoldEnum, MuteListResponse, MuteResponse, Networks, NeynarFrame, NeynarFramePage, NonceResponse, NotificationType, NotificationsResponse, OperationResponse, PostCastReqBodyEmbeds, PostCastResponse, ReactionType, ReactionsCastResponse, ReactionsResponse, ReactionsType, RegisterUserOnChainReqBodyRegistration, RegisterUserOnChainReqBodySignersInner, RegisterUserOnChainResponse, RegisterUserReqBodyMetadata, RegisterUserResponse, RelevantFollowersResponse, RelevantFungibleOwnersResponse, SearchCastsModeEnum, SearchSortType, SendFrameNotificationsReqBodyFilters, SendFrameNotificationsReqBodyNotification, SendFrameNotificationsResponse, SignedKeyRequestSponsor, Signer, SignerListResponse, StorageAllocationsResponse, StorageUsageResponse, SubscribedToResponse, SubscribersResponse, SubscriptionCheckResponse, SubscriptionProvider, SubscriptionProviders, SubscriptionsResponse, TransactionFrameResponse, TrendingChannelResponse, TrendingTimeWindow, 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;
@@ -1435,7 +1435,7 @@ export declare class NeynarAPIClient {
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 10, Maximum: 10)
      * @param {string} params.cursor [optional]  - Pagination cursor
      * @param {number} params.viewerFid [optional]  - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window for trending casts (7d window for channel feeds only)
+     * @param {TrendingTimeWindow & string} params.timeWindow [optional]  - Time window for trending casts (7d window for channel feeds only)
      * @param {string} params.channelId [optional]  - Channel ID to filter trending casts. Less active channels might have no casts in the time window selected. Provide either `channel_id` or `parent_url`, not both.
      * @param {string} params.parentUrl [optional]  - Parent URL to filter trending casts. Less active channels might have no casts in the time window selected. Provide either `channel_id` or `parent_url`, not both.
      * @param {FeedTrendingProvider} params.provider [optional]  - The provider of the trending casts feed.
@@ -1465,7 +1465,7 @@ export declare class NeynarAPIClient {
         limit?: number;
         cursor?: string;
         viewerFid?: number;
-        timeWindow?: TrendingTimeWindow;
+        timeWindow?: TrendingTimeWindow & string;
         channelId?: string;
         parentUrl?: string;
         provider?: FeedTrendingProvider;
@@ -1696,7 +1696,7 @@ export declare class NeynarAPIClient {
      * @param {object} params
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 100, Maximum: 100)
      * @param {string} params.cursor [optional]  - Pagination cursor
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to calculate the change in trending score for each mini app, used to sort mini app results
+     * @param {TrendingTimeWindow & string} params.timeWindow [optional]  - Time window used to calculate the change in trending score for each mini app, used to sort mini app results
      * @param {Array<FetchFrameCatalogCategoriesEnum>} params.categories [optional]  - Comma separated list of categories to include in the results.  Includes all if left blank.  Example: `categories=games,social` OR: `categories=games&categories=social`
      *
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
@@ -1715,7 +1715,7 @@ export declare class NeynarAPIClient {
     fetchFrameCatalog(params: {
         limit?: number;
         cursor?: string;
-        timeWindow?: TrendingTimeWindow;
+        timeWindow?: TrendingTimeWindow & string;
         categories?: Array<FetchFrameCatalogCategoriesEnum>;
     }): Promise<FrameCatalogResponse>;
     /**
@@ -1798,7 +1798,7 @@ export declare class NeynarAPIClient {
      *
      * @param {object} params
      * @param {number} params.viewerFid  - FID of the user to fetch relevant mini apps for
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to limit statistics used to calculate mini app relevance
+     * @param {TrendingTimeWindow & string} params.timeWindow [optional]  - Time window used to limit statistics used to calculate mini app relevance
      *
      * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
      *
@@ -1817,7 +1817,7 @@ export declare class NeynarAPIClient {
      */
     fetchRelevantFrames(params: {
         viewerFid: number;
-        timeWindow?: TrendingTimeWindow;
+        timeWindow?: TrendingTimeWindow & string;
     }): Promise<FetchRelevantFrames200Response>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
@@ -1995,8 +1995,9 @@ export declare class NeynarAPIClient {
      * @summary Send notifications
      *
      * @param {object} params
-     * @param {Array<number>} params.targetFids  - An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer, with a maximum of 100 FIDs allowed per call.
+     * @param {Array<number>} params.targetFids  - An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer. Pass an empty array to send notifications to all FIDs with notifications enabled for the mini app.
      * @param {SendFrameNotificationsReqBodyNotification} params.notification
+     * @param {SendFrameNotificationsReqBodyFilters} params.filters [optional]
      *
      * @returns {Promise<SendFrameNotificationsResponse>} A promise that resolves to a `SendFrameNotificationsResponse` object.
      *
@@ -2005,8 +2006,9 @@ export declare class NeynarAPIClient {
      * // Fill in the appropriate values
      * const targetFids =
      * const notification =
+     * const filters =
      *
-     * client.publishFrameNotifications({targetFids, notification}).then(response => {
+     * client.publishFrameNotifications({targetFids, notification, filters}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2016,6 +2018,7 @@ export declare class NeynarAPIClient {
     publishFrameNotifications(params: {
         targetFids: Array<number>;
         notification: SendFrameNotificationsReqBodyNotification;
+        filters?: SendFrameNotificationsReqBodyFilters;
     }): Promise<SendFrameNotificationsResponse>;
     /**
      * Create a new mini app with a list of pages.
@@ -2045,6 +2048,36 @@ export declare class NeynarAPIClient {
         name: string;
         pages: Array<NeynarFramePage>;
     }): Promise<NeynarFrame>;
+    /**
+     * Search for mini apps based on a query string
+     *
+     * @summary Search mini apps
+     *
+     * @param {object} params
+     * @param {string} params.q  - Query string to search for mini apps
+     * @param {number} params.limit [optional]  - Number of results to fetch (Default: 20, Maximum: 100)
+     * @param {string} params.cursor [optional]  - Pagination cursor
+     *
+     * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const q =
+     * const limit =
+     *
+     * client.searchFrames({ q, limit }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/search-frames)
+     *
+     */
+    searchFrames(params: {
+        q: string;
+        limit?: number;
+        cursor?: string;
+    }): Promise<FrameCatalogResponse>;
     /**
      * Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
      *
@@ -2259,7 +2292,7 @@ export declare class NeynarAPIClient {
      * @param {object} params
      * @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 {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the user follows.
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *
@@ -2295,7 +2328,7 @@ export declare class NeynarAPIClient {
      * @param {object} params
      * @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 {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the user follows.
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *
@@ -2331,7 +2364,7 @@ export declare class NeynarAPIClient {
      * @param {object} params
      * @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 {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the user follows.
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *

package/build/clients/NeynarAPIClient.js

@@ -1661,7 +1661,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 10, Maximum: 10)
      * @param {string} params.cursor [optional]  - Pagination cursor
      * @param {number} params.viewerFid [optional]  - Providing this will return a feed that respects this user's mutes and blocks and includes `viewer_context`.
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window for trending casts (7d window for channel feeds only)
+     * @param {TrendingTimeWindow & string} params.timeWindow [optional]  - Time window for trending casts (7d window for channel feeds only)
      * @param {string} params.channelId [optional]  - Channel ID to filter trending casts. Less active channels might have no casts in the time window selected. Provide either `channel_id` or `parent_url`, not both.
      * @param {string} params.parentUrl [optional]  - Parent URL to filter trending casts. Less active channels might have no casts in the time window selected. Provide either `channel_id` or `parent_url`, not both.
      * @param {FeedTrendingProvider} params.provider [optional]  - The provider of the trending casts feed.
@@ -1937,7 +1937,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 100, Maximum: 100)
      * @param {string} params.cursor [optional]  - Pagination cursor
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to calculate the change in trending score for each mini app, used to sort mini app results
+     * @param {TrendingTimeWindow & string} params.timeWindow [optional]  - Time window used to calculate the change in trending score for each mini app, used to sort mini app results
      * @param {Array<FetchFrameCatalogCategoriesEnum>} params.categories [optional]  - Comma separated list of categories to include in the results.  Includes all if left blank.  Example: `categories=games,social` OR: `categories=games&categories=social`
      *
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
@@ -2052,7 +2052,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {number} params.viewerFid  - FID of the user to fetch relevant mini apps for
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to limit statistics used to calculate mini app relevance
+     * @param {TrendingTimeWindow & string} params.timeWindow [optional]  - Time window used to limit statistics used to calculate mini app relevance
      *
      * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
      *
@@ -2261,8 +2261,9 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Send notifications
      *
      * @param {object} params
-     * @param {Array<number>} params.targetFids  - An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer, with a maximum of 100 FIDs allowed per call.
+     * @param {Array<number>} params.targetFids  - An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer. Pass an empty array to send notifications to all FIDs with notifications enabled for the mini app.
      * @param {SendFrameNotificationsReqBodyNotification} params.notification
+     * @param {SendFrameNotificationsReqBodyFilters} params.filters [optional]
      *
      * @returns {Promise<SendFrameNotificationsResponse>} A promise that resolves to a `SendFrameNotificationsResponse` object.
      *
@@ -2271,8 +2272,9 @@ const client = new NeynarAPIClient(config);\n`);
      * // Fill in the appropriate values
      * const targetFids =
      * const notification =
+     * const filters =
      *
-     * client.publishFrameNotifications({targetFids, notification}).then(response => {
+     * client.publishFrameNotifications({targetFids, notification, filters}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2317,6 +2319,37 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.frameApi.publishNeynarFrame(adjustedParams);
         return response.data;
     }
+    /**
+     * Search for mini apps based on a query string
+     *
+     * @summary Search mini apps
+     *
+     * @param {object} params
+     * @param {string} params.q  - Query string to search for mini apps
+     * @param {number} params.limit [optional]  - Number of results to fetch (Default: 20, Maximum: 100)
+     * @param {string} params.cursor [optional]  - Pagination cursor
+     *
+     * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const q =
+     * const limit =
+     *
+     * client.searchFrames({ q, limit }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/search-frames)
+     *
+     */
+    async searchFrames(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.frameApi.searchFrames(adjustedParams);
+        return response.data;
+    }
     /**
      * Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
      *
@@ -2547,7 +2580,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @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 {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the user follows.
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *
@@ -2582,7 +2615,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @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 {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the user follows.
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *
@@ -2620,7 +2653,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @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 {boolean} params.priorityMode [optional]  - When true, only returns notifications from power badge users and users that the user follows.
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 15, Maximum: 25)
      * @param {string} params.cursor [optional]  - Pagination cursor.
      *

package/package.json

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