@neynar/nodejs-sdk 2.27.1 → 2.30.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, 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, FramePayTransactionRequestBody, 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, TransactionFrameResponse, 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, 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, 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';
 export interface NeynarAPIClientOptions {
     logger?: Logger;
     axiosInstance?: AxiosInstance;
@@ -534,7 +534,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` - Searches for the words in the query string (default) - `semantic` - Searches for the meaning of the query string - `hybrid` - Combines both literal and semantic results
-     * @param {FollowSortType} params.sortType [optional]  - Choices are: - `desc_chron` - All casts sorted by time (default) - `algorithmic` - Casts sorted by engagement and time
+     * @param {SearchSortType} params.sortType [optional]  - Choices are: - `desc_chron` - All casts sorted by time (default) - `algorithmic` - Casts sorted by engagement and time
      * @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
@@ -568,7 +568,7 @@ export declare class NeynarAPIClient {
     searchCasts(params: {
         q: string;
         mode?: SearchCastsModeEnum;
-        sortType?: FollowSortType;
+        sortType?: SearchSortType;
         authorFid?: number;
         viewerFid?: number;
         parentUrl?: string;
@@ -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 {FetchTrendingFeedTimeWindowEnum} params.timeWindow [optional]  - Time window for trending casts (7d window for channel feeds only)
+     * @param {TrendingTimeWindow} 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?: FetchTrendingFeedTimeWindowEnum;
+        timeWindow?: TrendingTimeWindow;
         channelId?: string;
         parentUrl?: string;
         provider?: FeedTrendingProvider;
@@ -1696,6 +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 frame, used to sort frame results
      *
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
      *
@@ -1703,14 +1704,16 @@ export declare class NeynarAPIClient {
      *
      * // Fill in the appropriate values
      * const limit =
+     * const timeWindow =
      *
-     * client.fetchFrameCatalog({ limit }).then(response => {
+     * client.fetchFrameCatalog({ limit, timeWindow }).then(response => {
      *   console.log('response:', response);
      * });
      */
     fetchFrameCatalog(params: {
         limit?: number;
         cursor?: string;
+        timeWindow?: TrendingTimeWindow;
     }): Promise<FrameCatalogResponse>;
     /**
      * Fetches the frame meta tags from the URL
@@ -1785,6 +1788,31 @@ export declare class NeynarAPIClient {
         fids?: number[];
         cursor?: string;
     }): Promise<FrameNotificationTokens>;
+    /**
+     * Fetch a list of frames relevant to the user based on casts by users with strong affinity score for the user
+     *
+     * @summary Relevant frames
+     *
+     * @param {object} params
+     * @param {number} params.viewerFid  - FID of the user to fetch relevant frames for
+     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to limit statistics used to calculate frame relevance
+     *
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const viewerFid =
+     * const timeWindow =
+     *
+     * client.fetchRelevantFrames({ viewerFid, timeWindow }).then(response => {
+     *   console.log('response:', response);
+     * });
+     */
+    fetchRelevantFrames(params: {
+        viewerFid: number;
+        timeWindow?: TrendingTimeWindow;
+    }): Promise<FetchRelevantFrames200Response>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      *

package/build/clients/NeynarAPIClient.js

@@ -731,7 +731,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` - Searches for the words in the query string (default) - `semantic` - Searches for the meaning of the query string - `hybrid` - Combines both literal and semantic results
-     * @param {FollowSortType} params.sortType [optional]  - Choices are: - `desc_chron` - All casts sorted by time (default) - `algorithmic` - Casts sorted by engagement and time
+     * @param {SearchSortType} params.sortType [optional]  - Choices are: - `desc_chron` - All casts sorted by time (default) - `algorithmic` - Casts sorted by engagement and time
      * @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
@@ -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 {FetchTrendingFeedTimeWindowEnum} params.timeWindow [optional]  - Time window for trending casts (7d window for channel feeds only)
+     * @param {TrendingTimeWindow} 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,6 +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 frame, used to sort frame results
      *
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
      *
@@ -1944,8 +1945,9 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * // Fill in the appropriate values
      * const limit =
+     * const timeWindow =
      *
-     * client.fetchFrameCatalog({ limit }).then(response => {
+     * client.fetchFrameCatalog({ limit, timeWindow }).then(response => {
      *   console.log('response:', response);
      * });
      */
@@ -2041,6 +2043,33 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.frameApi.fetchNotificationTokens(adjustedParams);
         return response.data;
     }
+    /**
+     * Fetch a list of frames relevant to the user based on casts by users with strong affinity score for the user
+     *
+     * @summary Relevant frames
+     *
+     * @param {object} params
+     * @param {number} params.viewerFid  - FID of the user to fetch relevant frames for
+     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to limit statistics used to calculate frame relevance
+     *
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const viewerFid =
+     * const timeWindow =
+     *
+     * client.fetchRelevantFrames({ viewerFid, timeWindow }).then(response => {
+     *   console.log('response:', response);
+     * });
+     */
+    async fetchRelevantFrames(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.frameApi.fetchRelevantFrames(adjustedParams);
+        return response.data;
+    }
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      *

package/package.json

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

package/build/api/models/hydrated-follower.d.ts

@@ -1,35 +0,0 @@
-/**
- * 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.27.1
- * Contact: team@neynar.com
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-import type { User } from './user';
-/**
- *
- * @export
- * @interface HydratedFollower
- */
-export interface HydratedFollower {
-    /**
-     *
-     * @type {string}
-     * @memberof HydratedFollower
-     */
-    'object'?: HydratedFollowerObjectEnum;
-    /**
-     *
-     * @type {User}
-     * @memberof HydratedFollower
-     */
-    'user'?: User;
-}
-export declare const HydratedFollowerObjectEnum: {
-    readonly Follow: "follow";
-};
-export type HydratedFollowerObjectEnum = typeof HydratedFollowerObjectEnum[keyof typeof HydratedFollowerObjectEnum];