@neynar/nodejs-sdk 2.27.1 → 2.31.0

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.27.1
+ * The version of the OpenAPI document: 2.31.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.27.1
+ * The version of the OpenAPI document: 2.31.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.27.1
+ * The version of the OpenAPI document: 2.31.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.27.1
+ * The version of the OpenAPI document: 2.31.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.27.1
+ * The version of the OpenAPI document: 2.31.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.27.1
+ * The version of the OpenAPI document: 2.31.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

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

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

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

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

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

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

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

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

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

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

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

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

package/build/api/apis/user-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.27.1
+ * The version of the OpenAPI document: 2.31.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -168,6 +168,20 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
      *
      */
     lookupUserByUsername: (username: string, viewerFid?: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     * @summary By X username
+     * @param {string} xUsername X (Twitter) username to search for, without the @ symbol
+     * @param {number} [viewerFid] FID of the viewer for contextual information like follows and blocks
+     * @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<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    lookupUsersByXUsername: (xUsername: string, viewerFid?: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      * @summary Add verification
@@ -373,6 +387,20 @@ export declare const UserApiFp: (configuration?: Configuration) => {
      *
      */
     lookupUserByUsername(username: string, viewerFid?: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserResponse>>;
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     * @summary By X username
+     * @param {string} xUsername X (Twitter) username to search for, without the @ symbol
+     * @param {number} [viewerFid] FID of the viewer for contextual information like follows and blocks
+     * @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<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    lookupUsersByXUsername(xUsername: string, viewerFid?: number, xNeynarExperimental?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkUsersResponse>>;
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      * @summary Add verification
@@ -563,6 +591,18 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
      *
      */
     lookupUserByUsername(requestParameters: UserApiLookupUserByUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserResponse>;
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     * @summary By X username
+     * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @returns {Promise<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    lookupUsersByXUsername(requestParameters: UserApiLookupUsersByXUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise<BulkUsersResponse>;
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      * @summary Add verification
@@ -760,6 +800,19 @@ export interface UserApiInterface {
      *
      */
     lookupUserByUsername(requestParameters: UserApiLookupUserByUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserResponse>;
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     * @summary By X username
+     * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserApiInterface
+     * @returns {Promise<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    lookupUsersByXUsername(requestParameters: UserApiLookupUsersByXUsernameRequest, options?: RawAxiosRequestConfig): AxiosPromise<BulkUsersResponse>;
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      * @summary Add verification
@@ -1121,6 +1174,40 @@ export interface UserApiLookupUserByUsernameRequest {
      */
     readonly xNeynarExperimental?: boolean;
 }
+/**
+ * Request parameters for lookupUsersByXUsername operation in UserApi.
+ * @export
+ * @interface UserApiLookupUsersByXUsernameRequest
+ */
+export interface UserApiLookupUsersByXUsernameRequest {
+    /**
+     * X (Twitter) username to search for, without the @ symbol
+     *
+     *
+     *
+     * @type {string}
+     * @memberof UserApiLookupUsersByXUsername
+     */
+    readonly xUsername: string;
+    /**
+     * FID of the viewer for contextual information like follows and blocks
+     *
+     *
+     *
+     * @type {number}
+     * @memberof UserApiLookupUsersByXUsername
+     */
+    readonly viewerFid?: number;
+    /**
+     * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
+     *
+     *
+     * @globalHeader
+     * @type {boolean}
+     * @memberof UserApiLookupUsersByXUsername
+     */
+    readonly xNeynarExperimental?: boolean;
+}
 /**
  * Request parameters for publishVerification operation in UserApi.
  * @export
@@ -1374,6 +1461,19 @@ export declare class UserApi extends BaseAPI implements UserApiInterface {
      *
      */
     lookupUserByUsername(requestParameters: UserApiLookupUserByUsernameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserResponse, any>>;
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     * @summary By X username
+     * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserApi
+     * @returns {Promise<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    lookupUsersByXUsername(requestParameters: UserApiLookupUsersByXUsernameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkUsersResponse, any>>;
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      * @summary Add verification

package/build/api/apis/user-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.27.1
+ * The version of the OpenAPI document: 2.31.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -467,6 +467,53 @@ const UserApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Fetches the users who have verified the specified X (Twitter) username
+         * @summary By X username
+         * @param {string} xUsername X (Twitter) username to search for, without the @ symbol
+         * @param {number} [viewerFid] FID of the viewer for contextual information like follows and blocks
+         * @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<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+         *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+         *
+         */
+        lookupUsersByXUsername: async (xUsername, viewerFid, xNeynarExperimental, options = {}) => {
+            // verify required parameter 'xUsername' is not null or undefined
+            (0, common_1.assertParamExists)('lookupUsersByXUsername', 'xUsername', xUsername);
+            const localVarPath = `/farcaster/user/by_x_username`;
+            // 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 (xUsername !== undefined) {
+                localVarQueryParameter['x_username'] = xUsername;
+            }
+            if (viewerFid !== undefined) {
+                localVarQueryParameter['viewer_fid'] = viewerFid;
+            }
+            if (xNeynarExperimental != null) {
+                localVarHeaderParameter['x-neynar-experimental'] = typeof xNeynarExperimental === 'string'
+                    ? xNeynarExperimental
+                    : JSON.stringify(xNeynarExperimental);
+            }
+            (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,
+            };
+        },
         /**
          * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
          * @summary Add verification
@@ -871,6 +918,26 @@ const UserApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['UserApi.lookupUserByUsername']) === 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);
         },
+        /**
+         * Fetches the users who have verified the specified X (Twitter) username
+         * @summary By X username
+         * @param {string} xUsername X (Twitter) username to search for, without the @ symbol
+         * @param {number} [viewerFid] FID of the viewer for contextual information like follows and blocks
+         * @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<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+         *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+         *
+         */
+        async lookupUsersByXUsername(xUsername, viewerFid, xNeynarExperimental, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.lookupUsersByXUsername(xUsername, viewerFid, xNeynarExperimental, 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['UserApi.lookupUsersByXUsername']) === 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);
+        },
         /**
          * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
          * @summary Add verification
@@ -1115,6 +1182,20 @@ const UserApiFactory = function (configuration, basePath, axios) {
         lookupUserByUsername(requestParameters, options) {
             return localVarFp.lookupUserByUsername(requestParameters.username, requestParameters.viewerFid, requestParameters.xNeynarExperimental, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Fetches the users who have verified the specified X (Twitter) username
+         * @summary By X username
+         * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         * @returns {Promise<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+         *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+         *
+         */
+        lookupUsersByXUsername(requestParameters, options) {
+            return localVarFp.lookupUsersByXUsername(requestParameters.xUsername, requestParameters.viewerFid, requestParameters.xNeynarExperimental, options).then((request) => request(axios, basePath));
+        },
         /**
          * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
          * @summary Add verification
@@ -1345,6 +1426,21 @@ class UserApi extends base_1.BaseAPI {
     lookupUserByUsername(requestParameters, options) {
         return (0, exports.UserApiFp)(this.configuration).lookupUserByUsername(requestParameters.username, requestParameters.viewerFid, requestParameters.xNeynarExperimental, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     * @summary By X username
+     * @param {UserApiLookupUsersByXUsernameRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof UserApi
+     * @returns {Promise<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    lookupUsersByXUsername(requestParameters, options) {
+        return (0, exports.UserApiFp)(this.configuration).lookupUsersByXUsername(requestParameters.xUsername, requestParameters.viewerFid, requestParameters.xNeynarExperimental, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      * @summary Add verification