@neynar/nodejs-sdk 2.26.1 → 2.30.0

package/build/api/apis/follows-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,7 +27,7 @@ export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration
      * @param {number} fid FID of the user whose following you want to fetch.
      * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
      * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
@@ -41,7 +41,7 @@ export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration
      * @summary Relevant followers
      * @param {number} targetFid User who\&#39;s profile you are looking at
      * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
@@ -58,7 +58,7 @@ export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration
      * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is &#x60;desc_chron&#x60;
      * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
      * @param {string} [cursor] Pagination cursor.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
@@ -75,7 +75,7 @@ export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration
      * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria.
      * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
      * @param {string} [cursor] Pagination cursor.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
@@ -96,7 +96,7 @@ export declare const FollowsApiFp: (configuration?: Configuration) => {
      * @param {number} fid FID of the user whose following you want to fetch.
      * @param {number} [viewerFid] Providing this will return a list of users that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
      * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
@@ -110,7 +110,7 @@ export declare const FollowsApiFp: (configuration?: Configuration) => {
      * @summary Relevant followers
      * @param {number} targetFid User who\&#39;s profile you are looking at
      * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
@@ -127,7 +127,7 @@ export declare const FollowsApiFp: (configuration?: Configuration) => {
      * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is &#x60;desc_chron&#x60;
      * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
      * @param {string} [cursor] Pagination cursor.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
@@ -144,7 +144,7 @@ export declare const FollowsApiFp: (configuration?: Configuration) => {
      * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria.
      * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
      * @param {string} [cursor] Pagination cursor.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
@@ -301,7 +301,7 @@ export interface FollowsApiFetchFollowSuggestionsRequest {
      */
     readonly limit?: number;
     /**
-     * Enables experimental features
+     * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      *
      *
      * @globalHeader
@@ -335,7 +335,7 @@ export interface FollowsApiFetchRelevantFollowersRequest {
      */
     readonly viewerFid: number;
     /**
-     * Enables experimental features
+     * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      *
      *
      * @globalHeader
@@ -396,7 +396,7 @@ export interface FollowsApiFetchUserFollowersRequest {
      */
     readonly cursor?: string;
     /**
-     * Enables experimental features
+     * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      *
      *
      * @globalHeader
@@ -457,7 +457,7 @@ export interface FollowsApiFetchUserFollowingRequest {
      */
     readonly cursor?: string;
     /**
-     * Enables experimental features
+     * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      *
      *
      * @globalHeader

package/build/api/apis/follows-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -35,7 +35,7 @@ const FollowsApiAxiosParamCreator = function (configuration) {
          * @param {number} fid FID of the user whose following you want to fetch.
          * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
          * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
@@ -85,7 +85,7 @@ const FollowsApiAxiosParamCreator = function (configuration) {
          * @summary Relevant followers
          * @param {number} targetFid User who\&#39;s profile you are looking at
          * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
@@ -137,7 +137,7 @@ const FollowsApiAxiosParamCreator = function (configuration) {
          * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is &#x60;desc_chron&#x60;
          * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
          * @param {string} [cursor] Pagination cursor.
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
@@ -196,7 +196,7 @@ const FollowsApiAxiosParamCreator = function (configuration) {
          * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria.
          * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
          * @param {string} [cursor] Pagination cursor.
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
@@ -263,7 +263,7 @@ const FollowsApiFp = function (configuration) {
          * @param {number} fid FID of the user whose following you want to fetch.
          * @param {number} [viewerFid] Providing this will return a list of users that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
          * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<UsersResponse>} A promise that resolves to a `UsersResponse` object
@@ -283,7 +283,7 @@ const FollowsApiFp = function (configuration) {
          * @summary Relevant followers
          * @param {number} targetFid User who\&#39;s profile you are looking at
          * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<RelevantFollowersResponse>} A promise that resolves to a `RelevantFollowersResponse` object
@@ -306,7 +306,7 @@ const FollowsApiFp = function (configuration) {
          * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is &#x60;desc_chron&#x60;
          * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
          * @param {string} [cursor] Pagination cursor.
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object
@@ -329,7 +329,7 @@ const FollowsApiFp = function (configuration) {
          * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria.
          * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
          * @param {string} [cursor] Pagination cursor.
-         * @param {boolean} [xNeynarExperimental] Enables experimental features
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FollowersResponse>} A promise that resolves to a `FollowersResponse` object

package/build/api/apis/frame-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
 import type { DeleteFrameReqBody } from '../models';
 import type { DeleteFrameResponse } from '../models';
 import type { FetchFrameMetaTagsFromUrl200Response } from '../models';
+import type { FetchRelevantFrames200Response } from '../models';
 import type { Frame } from '../models';
 import type { FrameActionReqBody } from '../models';
 import type { FrameCatalogResponse } from '../models';
@@ -29,6 +30,7 @@ import type { NeynarFrameUpdateReqBody } from '../models';
 import type { SendFrameNotificationsReqBody } from '../models';
 import type { SendFrameNotificationsResponse } from '../models';
 import type { TransactionFrameResponse } from '../models';
+import type { TrendingTimeWindow } from '../models';
 import type { ValidateFrameActionReqBody } from '../models';
 import type { ValidateFrameActionResponse } from '../models';
 import type { ValidateFrameAggregateWindow } from '../models';
@@ -55,12 +57,13 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
      * @summary Frames Catalog
      * @param {number} [limit] Number of results to fetch  (Default: 100, Maximum: 100)
      * @param {string} [cursor] Pagination cursor
+     * @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each frame, used to sort frame results
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
      *
      */
-    fetchFrameCatalog: (limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    fetchFrameCatalog: (limit?: number, cursor?: string, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Fetches the frame meta tags from the URL
      * @summary Meta tags from URL
@@ -98,6 +101,17 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
      *
      */
     fetchNotificationTokens: (limit?: number, fids?: string, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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 {number} viewerFid FID of the user to fetch relevant frames for\\
+     * @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate frame relevance
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+     *
+     */
+    fetchRelevantFrames: (viewerFid: number, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      * @summary Analytics for the frame
@@ -244,12 +258,13 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
      * @summary Frames Catalog
      * @param {number} [limit] Number of results to fetch  (Default: 100, Maximum: 100)
      * @param {string} [cursor] Pagination cursor
+     * @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each frame, used to sort frame results
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
      *
      */
-    fetchFrameCatalog(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameCatalogResponse>>;
+    fetchFrameCatalog(limit?: number, cursor?: string, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameCatalogResponse>>;
     /**
      * Fetches the frame meta tags from the URL
      * @summary Meta tags from URL
@@ -287,6 +302,17 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
      *
      */
     fetchNotificationTokens(limit?: number, fids?: string, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<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 {number} viewerFid FID of the user to fetch relevant frames for\\
+     * @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate frame relevance
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+     *
+     */
+    fetchRelevantFrames(viewerFid: number, timeWindow?: TrendingTimeWindow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchRelevantFrames200Response>>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      * @summary Analytics for the frame
@@ -473,6 +499,16 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      *
      */
     fetchNotificationTokens(requestParameters?: FrameApiFetchNotificationTokensRequest, options?: RawAxiosRequestConfig): AxiosPromise<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 {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+     *
+     */
+    fetchRelevantFrames(requestParameters: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchRelevantFrames200Response>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      * @summary Analytics for the frame
@@ -659,6 +695,17 @@ export interface FrameApiInterface {
      *
      */
     fetchNotificationTokens(requestParameters?: FrameApiFetchNotificationTokensRequest, options?: RawAxiosRequestConfig): AxiosPromise<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 {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FrameApiInterface
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+     *
+     */
+    fetchRelevantFrames(requestParameters: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchRelevantFrames200Response>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      * @summary Analytics for the frame
@@ -827,6 +874,15 @@ export interface FrameApiFetchFrameCatalogRequest {
      * @memberof FrameApiFetchFrameCatalog
      */
     readonly cursor?: string;
+    /**
+     * Time window used to calculate the change in trending score for each frame, used to sort frame results
+     *
+     *
+     *
+     * @type {TrendingTimeWindow}
+     * @memberof FrameApiFetchFrameCatalog
+     */
+    readonly timeWindow?: TrendingTimeWindow;
 }
 /**
  * Request parameters for fetchFrameMetaTagsFromUrl operation in FrameApi.
@@ -878,6 +934,31 @@ export interface FrameApiFetchNotificationTokensRequest {
      */
     readonly cursor?: string;
 }
+/**
+ * Request parameters for fetchRelevantFrames operation in FrameApi.
+ * @export
+ * @interface FrameApiFetchRelevantFramesRequest
+ */
+export interface FrameApiFetchRelevantFramesRequest {
+    /**
+     * FID of the user to fetch relevant frames for\\
+     *
+     *
+     *
+     * @type {number}
+     * @memberof FrameApiFetchRelevantFrames
+     */
+    readonly viewerFid: number;
+    /**
+     * Time window used to limit statistics used to calculate frame relevance
+     *
+     *
+     *
+     * @type {TrendingTimeWindow}
+     * @memberof FrameApiFetchRelevantFrames
+     */
+    readonly timeWindow?: TrendingTimeWindow;
+}
 /**
  * Request parameters for fetchValidateFrameAnalytics operation in FrameApi.
  * @export
@@ -1145,6 +1226,17 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      *
      */
     fetchNotificationTokens(requestParameters?: FrameApiFetchNotificationTokensRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FrameNotificationTokens, any>>;
+    /**
+     * 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 {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FrameApi
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+     *
+     */
+    fetchRelevantFrames(requestParameters: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchRelevantFrames200Response, any>>;
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      * @summary Analytics for the frame

package/build/api/apis/frame-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -70,12 +70,13 @@ const FrameApiAxiosParamCreator = function (configuration) {
          * @summary Frames Catalog
          * @param {number} [limit] Number of results to fetch  (Default: 100, Maximum: 100)
          * @param {string} [cursor] Pagination cursor
+         * @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each frame, used to sort frame results
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
          *
          */
-        fetchFrameCatalog: async (limit, cursor, options = {}) => {
+        fetchFrameCatalog: async (limit, cursor, timeWindow, options = {}) => {
             const localVarPath = `/farcaster/frame/catalog`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -94,6 +95,9 @@ const FrameApiAxiosParamCreator = function (configuration) {
             if (cursor !== undefined) {
                 localVarQueryParameter['cursor'] = cursor;
             }
+            if (timeWindow !== undefined) {
+                localVarQueryParameter['time_window'] = timeWindow;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -213,6 +217,45 @@ const FrameApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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 {number} viewerFid FID of the user to fetch relevant frames for\\
+         * @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate frame relevance
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+         *
+         */
+        fetchRelevantFrames: async (viewerFid, timeWindow, options = {}) => {
+            // verify required parameter 'viewerFid' is not null or undefined
+            (0, common_1.assertParamExists)('fetchRelevantFrames', 'viewerFid', viewerFid);
+            const localVarPath = `/farcaster/frame/relevant`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
+            if (viewerFid !== undefined) {
+                localVarQueryParameter['viewer_fid'] = viewerFid;
+            }
+            if (timeWindow !== undefined) {
+                localVarQueryParameter['time_window'] = timeWindow;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
          * @summary Analytics for the frame
@@ -636,14 +679,15 @@ const FrameApiFp = function (configuration) {
          * @summary Frames Catalog
          * @param {number} [limit] Number of results to fetch  (Default: 100, Maximum: 100)
          * @param {string} [cursor] Pagination cursor
+         * @param {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each frame, used to sort frame results
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
          *
          */
-        async fetchFrameCatalog(limit, cursor, options) {
+        async fetchFrameCatalog(limit, cursor, timeWindow, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchFrameCatalog(limit, cursor, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchFrameCatalog(limit, cursor, timeWindow, options);
             const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.fetchFrameCatalog']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -703,6 +747,23 @@ const FrameApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.fetchNotificationTokens']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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 {number} viewerFid FID of the user to fetch relevant frames for\\
+         * @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate frame relevance
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+         *
+         */
+        async fetchRelevantFrames(viewerFid, timeWindow, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchRelevantFrames(viewerFid, timeWindow, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.fetchRelevantFrames']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
          * @summary Analytics for the frame
@@ -920,7 +981,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
          *
          */
         fetchFrameCatalog(requestParameters = {}, options) {
-            return localVarFp.fetchFrameCatalog(requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
+            return localVarFp.fetchFrameCatalog(requestParameters.limit, requestParameters.cursor, requestParameters.timeWindow, options).then((request) => request(axios, basePath));
         },
         /**
          * Fetches the frame meta tags from the URL
@@ -963,6 +1024,18 @@ const FrameApiFactory = function (configuration, basePath, axios) {
         fetchNotificationTokens(requestParameters = {}, options) {
             return localVarFp.fetchNotificationTokens(requestParameters.limit, requestParameters.fids, requestParameters.cursor, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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 {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+         *
+         */
+        fetchRelevantFrames(requestParameters, options) {
+            return localVarFp.fetchRelevantFrames(requestParameters.viewerFid, requestParameters.timeWindow, options).then((request) => request(axios, basePath));
+        },
         /**
          * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
          * @summary Analytics for the frame
@@ -1136,7 +1209,7 @@ class FrameApi extends base_1.BaseAPI {
      *
      */
     fetchFrameCatalog(requestParameters = {}, options) {
-        return (0, exports.FrameApiFp)(this.configuration).fetchFrameCatalog(requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.FrameApiFp)(this.configuration).fetchFrameCatalog(requestParameters.limit, requestParameters.cursor, requestParameters.timeWindow, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Fetches the frame meta tags from the URL
@@ -1182,6 +1255,19 @@ class FrameApi extends base_1.BaseAPI {
     fetchNotificationTokens(requestParameters = {}, options) {
         return (0, exports.FrameApiFp)(this.configuration).fetchNotificationTokens(requestParameters.limit, requestParameters.fids, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * 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 {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FrameApi
+     * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
+     *
+     */
+    fetchRelevantFrames(requestParameters, options) {
+        return (0, exports.FrameApiFp)(this.configuration).fetchRelevantFrames(requestParameters.viewerFid, requestParameters.timeWindow, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      * @summary Analytics for the frame

package/build/api/apis/login-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/apis/login-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/apis/metrics-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/apis/metrics-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/apis/mute-api.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.26.1
+ * The version of the OpenAPI document: 2.30.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -38,7 +38,7 @@ export declare const MuteApiAxiosParamCreator: (configuration?: Configuration) =
      * @param {number} fid The user\'s FID (identifier)
      * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
      * @param {string} [cursor] Pagination cursor.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<MuteListResponse>} A promise that resolves to a `MuteListResponse` object
@@ -83,7 +83,7 @@ export declare const MuteApiFp: (configuration?: Configuration) => {
      * @param {number} fid The user\&#39;s FID (identifier)
      * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
      * @param {string} [cursor] Pagination cursor.
-     * @param {boolean} [xNeynarExperimental] Enables experimental features
+     * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<MuteListResponse>} A promise that resolves to a `MuteListResponse` object
@@ -243,7 +243,7 @@ export interface MuteApiFetchMuteListRequest {
      */
     readonly cursor?: string;
     /**
-     * Enables experimental features
+     * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      *
      *
      * @globalHeader