@neynar/nodejs-sdk 2.30.0 → 2.31.0

package/build/api/models/webhook-subscription-filters-reaction.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.30.0
+ * 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/models/webhook-subscription-filters-user-updated.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.30.0
+ * 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/models/webhook-subscription-filters-user-updated.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.30.0
+ * 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/models/webhook-subscription-filters.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.30.0
+ * 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/models/webhook-subscription-filters.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.30.0
+ * 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/models/webhook-subscription.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.30.0
+ * 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/models/webhook-subscription.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.30.0
+ * 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/models/webhook.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.30.0
+ * 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/models/webhook.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.30.0
+ * 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/models/zod-error-errors-inner.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.30.0
+ * 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/models/zod-error-errors-inner.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.30.0
+ * 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/models/zod-error.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.30.0
+ * 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/models/zod-error.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.30.0
+ * 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/clients/NeynarAPIClient.d.ts

@@ -532,7 +532,7 @@ export declare class NeynarAPIClient {
      * @summary Search for casts
      *
      * @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 {string} params.q  - Query string to search for casts. Supported operators:  | Operator  | Description                                                                                              | | --------- | -------------------------------------------------------------------------------------------------------- | | `+`       | Acts as the AND operator. This is the default operator between terms and can usually be omitted.         | | `|`      | Acts as the OR operator.                                                                                 | | `*`       | When used at the end of a term, signifies a prefix query.                                                  | | `"`       | Wraps several terms into a phrase (for example, `"star wars"`).                                          | | `(`, `)`  | Wrap a clause for precedence (for example, `star + (wars | trek)`).                                     | | `~n`      | When used after a term (for example, `satr~3`), sets `fuzziness`. When used after a phrase, sets `slop`. | | `-`       | Negates the term.                                                                                        | | `before:` | Search for casts before a specific date. (e.g. `before:2025-04-20`)                                       | | `after:`  | Search for casts after a specific date. (e.g. `after:2025-04-20`)                                         |
      * @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 {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
@@ -3354,6 +3354,34 @@ export declare class NeynarAPIClient {
         username: string;
         viewerFid?: number;
     }): Promise<UserResponse>;
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     *
+     * @summary By X username
+     *
+     * @param {object} params
+     * @param {string} params.xUsername  - X (Twitter) username to search for, without the @ symbol
+     * @param {number} params.viewerFid [optional]  - FID of the viewer for contextual information like follows and blocks
+     *
+     * @returns {Promise<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const xUsername =
+     * const viewerFid =
+     *
+     * client.lookupUsersByXUsername({ xUsername, viewerFid }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    lookupUsersByXUsername(params: {
+        xUsername: string;
+        viewerFid?: number;
+    }): Promise<BulkUsersResponse>;
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      *

package/build/clients/NeynarAPIClient.js

@@ -729,7 +729,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Search for casts
      *
      * @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 {string} params.q  - Query string to search for casts. Supported operators:  | Operator  | Description                                                                                              | | --------- | -------------------------------------------------------------------------------------------------------- | | `+`       | Acts as the AND operator. This is the default operator between terms and can usually be omitted.         | | `|`      | Acts as the OR operator.                                                                                 | | `*`       | When used at the end of a term, signifies a prefix query.                                                  | | `"`       | Wraps several terms into a phrase (for example, `"star wars"`).                                          | | `(`, `)`  | Wrap a clause for precedence (for example, `star + (wars | trek)`).                                     | | `~n`      | When used after a term (for example, `satr~3`), sets `fuzziness`. When used after a phrase, sets `slop`. | | `-`       | Negates the term.                                                                                        | | `before:` | Search for casts before a specific date. (e.g. `before:2025-04-20`)                                       | | `after:`  | Search for casts after a specific date. (e.g. `after:2025-04-20`)                                         |
      * @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 {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
@@ -3714,6 +3714,38 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.userApi.lookupUserByUsername(adjustedParams);
         return response.data;
     }
+    /**
+     * Fetches the users who have verified the specified X (Twitter) username
+     *
+     * @summary By X username
+     *
+     * @param {object} params
+     * @param {string} params.xUsername  - X (Twitter) username to search for, without the @ symbol
+     * @param {number} params.viewerFid [optional]  - FID of the viewer for contextual information like follows and blocks
+     *
+     * @returns {Promise<BulkUsersResponse>} A promise that resolves to a `BulkUsersResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const xUsername =
+     * const viewerFid =
+     *
+     * client.lookupUsersByXUsername({ xUsername, viewerFid }).then(response => {
+     *   console.log('response:', response);
+     * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-users-by-x-username)
+     *
+     */
+    async lookupUsersByXUsername(params) {
+        var _a, _b;
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        adjustedParams['xNeynarExperimental'] = (_b = (_a = this.config.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) === null || _b === void 0 ? void 0 : _b['x-neynar-experimental'];
+        const response = await this.apis.userApi.lookupUsersByXUsername(adjustedParams);
+        return response.data;
+    }
     /**
      * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved)
      *

package/build/clients/NeynarHubClient.d.ts

@@ -537,7 +537,7 @@ export declare class NeynarHubClient {
      *
      * @param {object} params
      * @param {string} params.url  - Target URL starting with 'chain://'.
-     * @param {ReactionType} params.reactionType
+     * @param {ReactionType} params.reactionType [optional]
      * @param {number} params.pageSize [optional]  - Maximum number of messages to return in a single response
      * @param {boolean} params.reverse [optional]  - Reverse the sort order, returning latest messages first
      * @param {string} params.pageToken [optional]  - The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
@@ -562,7 +562,7 @@ export declare class NeynarHubClient {
      */
     fetchReactionsByTarget(params: {
         url: string;
-        reactionType: ReactionType;
+        reactionType?: ReactionType;
         pageSize?: number;
         reverse?: boolean;
         pageToken?: string;

package/build/clients/NeynarHubClient.js

@@ -691,7 +691,7 @@ const client = new NeynarHubClient(config);\n`);
      *
      * @param {object} params
      * @param {string} params.url  - Target URL starting with 'chain://'.
-     * @param {ReactionType} params.reactionType
+     * @param {ReactionType} params.reactionType [optional]
      * @param {number} params.pageSize [optional]  - Maximum number of messages to return in a single response
      * @param {boolean} params.reverse [optional]  - Reverse the sort order, returning latest messages first
      * @param {string} params.pageToken [optional]  - The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page

package/build/hub-api/apis/reactions-api.d.ts

@@ -41,7 +41,7 @@ export declare const ReactionsApiAxiosParamCreator: (configuration?: Configurati
      * Fetch all reactions of a specific type (like or recast) that target a given URL. This endpoint is useful for tracking engagement with content across the Farcaster network.
      * @summary To a target URL
      * @param {string} url Target URL starting with \'chain://\'.
-     * @param {ReactionType} reactionType
+     * @param {ReactionType} [reactionType]
      * @param {number} [pageSize] Maximum number of messages to return in a single response
      * @param {boolean} [reverse] Reverse the sort order, returning latest messages first
      * @param {string} [pageToken] The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
@@ -52,7 +52,7 @@ export declare const ReactionsApiAxiosParamCreator: (configuration?: Configurati
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-reactions-by-target)
      *
      */
-    fetchReactionsByTarget: (url: string, reactionType: ReactionType, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    fetchReactionsByTarget: (url: string, reactionType?: ReactionType, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Fetch reactions by a user.
      * @summary By FID
@@ -111,7 +111,7 @@ export declare const ReactionsApiFp: (configuration?: Configuration) => {
      * Fetch all reactions of a specific type (like or recast) that target a given URL. This endpoint is useful for tracking engagement with content across the Farcaster network.
      * @summary To a target URL
      * @param {string} url Target URL starting with \&#39;chain://\&#39;.
-     * @param {ReactionType} reactionType
+     * @param {ReactionType} [reactionType]
      * @param {number} [pageSize] Maximum number of messages to return in a single response
      * @param {boolean} [reverse] Reverse the sort order, returning latest messages first
      * @param {string} [pageToken] The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
@@ -122,7 +122,7 @@ export declare const ReactionsApiFp: (configuration?: Configuration) => {
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-reactions-by-target)
      *
      */
-    fetchReactionsByTarget(url: string, reactionType: ReactionType, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchCastReactions200Response>>;
+    fetchReactionsByTarget(url: string, reactionType?: ReactionType, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchCastReactions200Response>>;
     /**
      * Fetch reactions by a user.
      * @summary By FID
@@ -352,7 +352,7 @@ export interface ReactionsApiFetchReactionsByTargetRequest {
      * @type {ReactionType}
      * @memberof ReactionsApiFetchReactionsByTarget
      */
-    readonly reactionType: ReactionType;
+    readonly reactionType?: ReactionType;
     /**
      * Maximum number of messages to return in a single response
      *

package/build/hub-api/apis/reactions-api.js

@@ -94,7 +94,7 @@ const ReactionsApiAxiosParamCreator = function (configuration) {
          * Fetch all reactions of a specific type (like or recast) that target a given URL. This endpoint is useful for tracking engagement with content across the Farcaster network.
          * @summary To a target URL
          * @param {string} url Target URL starting with \'chain://\'.
-         * @param {ReactionType} reactionType
+         * @param {ReactionType} [reactionType]
          * @param {number} [pageSize] Maximum number of messages to return in a single response
          * @param {boolean} [reverse] Reverse the sort order, returning latest messages first
          * @param {string} [pageToken] The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page
@@ -108,8 +108,6 @@ const ReactionsApiAxiosParamCreator = function (configuration) {
         fetchReactionsByTarget: async (url, reactionType, pageSize, reverse, pageToken, options = {}) => {
             // verify required parameter 'url' is not null or undefined
             (0, common_1.assertParamExists)('fetchReactionsByTarget', 'url', url);
-            // verify required parameter 'reactionType' is not null or undefined
-            (0, common_1.assertParamExists)('fetchReactionsByTarget', 'reactionType', reactionType);
             const localVarPath = `/v1/reactionsByTarget`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -292,7 +290,7 @@ const ReactionsApiFp = function (configuration) {
          * Fetch all reactions of a specific type (like or recast) that target a given URL. This endpoint is useful for tracking engagement with content across the Farcaster network.
          * @summary To a target URL
          * @param {string} url Target URL starting with \'chain://\'.
-         * @param {ReactionType} reactionType
+         * @param {ReactionType} [reactionType]
          * @param {number} [pageSize] Maximum number of messages to return in a single response
          * @param {boolean} [reverse] Reverse the sort order, returning latest messages first
          * @param {string} [pageToken] The page token returned by the previous query, to fetch the next page. If this parameter is empty, fetch the first page

package/build/hub-api/models/reaction-type.d.ts

@@ -10,12 +10,12 @@
  * Do not edit the class manually.
  */
 /**
- * Type of interaction a user can have with content on the Farcaster network. - REACTION_TYPE_LIKE: Express appreciation for the target content. Similar to \"likes\" or \"favorites\" on other platforms. - REACTION_TYPE_RECAST: Share the target content with the user\'s followers, similar to a \"retweet\" or \"reblog\". Helps increase content visibility.
+ * Type of interaction a user can have with content on the Farcaster network. - Like: Express appreciation for the target content. Similar to \"likes\" or \"favorites\" on other platforms. - Recast: Share the target content with the user\'s followers, similar to a \"retweet\" or \"reblog\". Helps increase content visibility.
  * @export
  * @enum {string}
  */
 export declare const ReactionType: {
-    readonly Like: "REACTION_TYPE_LIKE";
-    readonly Recast: "REACTION_TYPE_RECAST";
+    readonly Like: "Like";
+    readonly Recast: "Recast";
 };
 export type ReactionType = typeof ReactionType[keyof typeof ReactionType];

package/build/hub-api/models/reaction-type.js

@@ -15,11 +15,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReactionType = void 0;
 /**
- * Type of interaction a user can have with content on the Farcaster network. - REACTION_TYPE_LIKE: Express appreciation for the target content. Similar to \"likes\" or \"favorites\" on other platforms. - REACTION_TYPE_RECAST: Share the target content with the user\'s followers, similar to a \"retweet\" or \"reblog\". Helps increase content visibility.
+ * Type of interaction a user can have with content on the Farcaster network. - Like: Express appreciation for the target content. Similar to \"likes\" or \"favorites\" on other platforms. - Recast: Share the target content with the user\'s followers, similar to a \"retweet\" or \"reblog\". Helps increase content visibility.
  * @export
  * @enum {string}
  */
 exports.ReactionType = {
-    Like: 'REACTION_TYPE_LIKE',
-    Recast: 'REACTION_TYPE_RECAST'
+    Like: 'Like',
+    Recast: 'Recast'
 };

package/package.json

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