@neynar/nodejs-sdk 2.6.1 → 2.7.1

package/build/clients/NeynarHubClient.d.ts

@@ -1,7 +1,7 @@
 import { Logger } from "../common/logger";
 import { AxiosInstance } from "axios";
 import { Configuration } from './configuration';
-import type { CastAdd, FetchCastReactions200Response, FetchEvents200Response, FetchUserData200Response, FetchUserFollowing200Response, FetchUserOnChainEvents200Response, FetchUserOnChainSignersEvents200Response, FetchUsersCasts200Response, FetchVerificationsByFid200Response, FidsResponse, HubEvent, HubInfoResponse, LinkAdd, LinkType, Message, OnChainEventIdRegister, OnChainEventType, Reaction, ReactionType, StorageLimitsResponse, UserDataType, UserNameProof, UsernameProofsResponse, ValidateMessageResponse } from '../hub-api';
+import type { CastAdd, FetchCastReactions200Response, FetchCastsByParent200Response, FetchEvents200Response, FetchUserData200Response, FetchUserFollowing200Response, FetchUserOnChainEvents200Response, FetchUserOnChainSignersEvents200Response, FetchUsersCasts200Response, FetchVerificationsByFid200Response, FidsResponse, HubEvent, HubInfoResponse, LinkAdd, LinkType, Message, OnChainEventIdRegister, OnChainEventType, Reaction, ReactionType, StorageLimitsResponse, UserDataType, UserNameProof, UsernameProofsResponse, ValidateMessageResponse } from '../hub-api';
 export interface NeynarHubClientOptions {
     logger?: Logger;
     axiosInstance?: AxiosInstance;
@@ -13,19 +13,19 @@ export declare class NeynarHubClient {
     constructor(config: Configuration, options?: NeynarHubClientOptions);
     static isApiErrorResponse(error: any): boolean;
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      *
      * @summary By parent cast
      *
      * @param {object} params
-     * @param {number} params.fid [optional]  - The FID of the parent cast
-     * @param {string} params.hash [optional]  - The parent cast's hash
-     * @param {string} params.url [optional]
+     * @param {number} params.fid [optional]  - The Farcaster ID (FID) of the parent cast's creator. This parameter must be used together with the 'hash' parameter to uniquely identify a parent cast. Required only when using hash-based lookup instead of URL-based lookup. The FID is a unique identifier assigned to each Farcaster user.
+     * @param {string} params.hash [optional]  - The unique hash identifier of the parent cast. Must be used together with the 'fid' parameter when doing hash-based lookup. This is a 40-character hexadecimal string prefixed with '0x' that uniquely identifies the cast within the creator's posts. Not required if using URL-based lookup.
+     * @param {string} params.url [optional]  - Cast URL starting with 'chain://'
      * @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
      *
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object.
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object.
      *
      * @example
      *
@@ -51,7 +51,7 @@ export declare class NeynarHubClient {
         pageSize?: number;
         reverse?: boolean;
         pageToken?: string;
-    }): Promise<FetchUsersCasts200Response>;
+    }): Promise<FetchCastsByParent200Response>;
     /**
      * Fetch casts mentioning a user.
      *
@@ -127,7 +127,7 @@ export declare class NeynarHubClient {
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the cast's creator
-     * @param {string} params.hash  - The cast's hash
+     * @param {string} params.hash  - The unique hash identifier of the cast. This is a 40-character hexadecimal string prefixed with '0x' that uniquely identifies a specific cast in the Farcaster network.
      *
      * @returns {Promise<CastAdd>} A promise that resolves to a `CastAdd` object.
      *
@@ -235,7 +235,7 @@ export declare class NeynarHubClient {
      * @summary Sync Methods
      *
      * @param {object} params
-     * @param {boolean} params.dbstats  - Whether to return DB stats
+     * @param {boolean} params.dbstats  - Controls whether the response includes database statistics. When true, the response includes information about the hub's database state, storage usage, and performance metrics.
      *
      * @returns {Promise<HubInfoResponse>} A promise that resolves to a `HubInfoResponse` object.
      *
@@ -260,8 +260,8 @@ export declare class NeynarHubClient {
      * @summary To target FID
      *
      * @param {object} params
-     * @param {number} params.targetFid  - The FID of the target of the link
-     * @param {LinkType} params.linkType [optional]  - The type of link, as a string value
+     * @param {number} params.targetFid  - The FID of the target user for this link
+     * @param {LinkType} params.linkType [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
@@ -298,7 +298,7 @@ export declare class NeynarHubClient {
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the link's originator
-     * @param {LinkType} params.linkType [optional]  - The type of link, as a string value
+     * @param {LinkType} params.linkType [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
@@ -335,8 +335,8 @@ export declare class NeynarHubClient {
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the link's originator
-     * @param {number} params.targetFid  - The FID of the target of the link
-     * @param {LinkType} params.linkType  - The type of link, as a string value
+     * @param {number} params.targetFid  - The FID of the target user for this link
+     * @param {LinkType} params.linkType
      *
      * @returns {Promise<LinkAdd>} A promise that resolves to a `LinkAdd` object.
      *
@@ -491,14 +491,14 @@ export declare class NeynarHubClient {
         address: string;
     }): Promise<OnChainEventIdRegister>;
     /**
-     * Fetch reactions on a cast.
+     * Retrieve all reactions (likes or recasts) on a specific cast in the Farcaster network. The cast is identified by its creator\'s FID and unique hash. This endpoint helps track engagement metrics and user interactions with specific content.
      *
      * @summary On cast
      *
      * @param {object} params
-     * @param {number} params.targetFid  - The FID of the cast's creator
-     * @param {string} params.targetHash  - The hash of the cast
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {number} params.targetFid  - The FID of the cast's creator. Required to uniquely identify the cast that received the reactions. Must be used in conjunction with target_hash.
+     * @param {string} params.targetHash  - The unique hash identifier of the cast that received the reactions. This is a 40-character hexadecimal string prefixed with '0x' that uniquely identifies the cast within the creator's posts. Must be used with target_fid.
+     * @param {ReactionType} params.reactionType
      * @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
@@ -531,13 +531,13 @@ export declare class NeynarHubClient {
         pageToken?: string;
     }): Promise<FetchCastReactions200Response>;
     /**
-     * Fetch reactions by a target URL.
+     * 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 {object} params
-     * @param {string} params.url  - The URL of the parent cast
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {string} params.url  - Target URL starting with 'chain://'.
+     * @param {ReactionType} params.reactionType
      * @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
@@ -574,7 +574,7 @@ export declare class NeynarHubClient {
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the reaction's creator
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {ReactionType} params.reactionType
      * @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
@@ -613,7 +613,7 @@ export declare class NeynarHubClient {
      * @param {number} params.fid  - The FID of the reaction's creator
      * @param {number} params.targetFid  - The FID of the cast's creator
      * @param {string} params.targetHash  - The cast's hash
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {ReactionType} params.reactionType
      *
      * @returns {Promise<Reaction>} A promise that resolves to a `Reaction` object.
      *

package/build/clients/NeynarHubClient.js

@@ -147,19 +147,19 @@ const client = new NeynarHubClient(config);\n`);
         return (((_a = error.response) === null || _a === void 0 ? void 0 : _a.data) !== undefined && "message" in error.response.data);
     }
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      *
      * @summary By parent cast
      *
      * @param {object} params
-     * @param {number} params.fid [optional]  - The FID of the parent cast
-     * @param {string} params.hash [optional]  - The parent cast's hash
-     * @param {string} params.url [optional]
+     * @param {number} params.fid [optional]  - The Farcaster ID (FID) of the parent cast's creator. This parameter must be used together with the 'hash' parameter to uniquely identify a parent cast. Required only when using hash-based lookup instead of URL-based lookup. The FID is a unique identifier assigned to each Farcaster user.
+     * @param {string} params.hash [optional]  - The unique hash identifier of the parent cast. Must be used together with the 'fid' parameter when doing hash-based lookup. This is a 40-character hexadecimal string prefixed with '0x' that uniquely identifies the cast within the creator's posts. Not required if using URL-based lookup.
+     * @param {string} params.url [optional]  - Cast URL starting with 'chain://'
      * @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
      *
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object.
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object.
      *
      * @example
      *
@@ -259,7 +259,7 @@ const client = new NeynarHubClient(config);\n`);
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the cast's creator
-     * @param {string} params.hash  - The cast's hash
+     * @param {string} params.hash  - The unique hash identifier of the cast. This is a 40-character hexadecimal string prefixed with '0x' that uniquely identifies a specific cast in the Farcaster network.
      *
      * @returns {Promise<CastAdd>} A promise that resolves to a `CastAdd` object.
      *
@@ -376,7 +376,7 @@ const client = new NeynarHubClient(config);\n`);
      * @summary Sync Methods
      *
      * @param {object} params
-     * @param {boolean} params.dbstats  - Whether to return DB stats
+     * @param {boolean} params.dbstats  - Controls whether the response includes database statistics. When true, the response includes information about the hub's database state, storage usage, and performance metrics.
      *
      * @returns {Promise<HubInfoResponse>} A promise that resolves to a `HubInfoResponse` object.
      *
@@ -404,8 +404,8 @@ const client = new NeynarHubClient(config);\n`);
      * @summary To target FID
      *
      * @param {object} params
-     * @param {number} params.targetFid  - The FID of the target of the link
-     * @param {LinkType} params.linkType [optional]  - The type of link, as a string value
+     * @param {number} params.targetFid  - The FID of the target user for this link
+     * @param {LinkType} params.linkType [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
@@ -441,7 +441,7 @@ const client = new NeynarHubClient(config);\n`);
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the link's originator
-     * @param {LinkType} params.linkType [optional]  - The type of link, as a string value
+     * @param {LinkType} params.linkType [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
@@ -477,8 +477,8 @@ const client = new NeynarHubClient(config);\n`);
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the link's originator
-     * @param {number} params.targetFid  - The FID of the target of the link
-     * @param {LinkType} params.linkType  - The type of link, as a string value
+     * @param {number} params.targetFid  - The FID of the target user for this link
+     * @param {LinkType} params.linkType
      *
      * @returns {Promise<LinkAdd>} A promise that resolves to a `LinkAdd` object.
      *
@@ -647,14 +647,14 @@ const client = new NeynarHubClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch reactions on a cast.
+     * Retrieve all reactions (likes or recasts) on a specific cast in the Farcaster network. The cast is identified by its creator\'s FID and unique hash. This endpoint helps track engagement metrics and user interactions with specific content.
      *
      * @summary On cast
      *
      * @param {object} params
-     * @param {number} params.targetFid  - The FID of the cast's creator
-     * @param {string} params.targetHash  - The hash of the cast
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {number} params.targetFid  - The FID of the cast's creator. Required to uniquely identify the cast that received the reactions. Must be used in conjunction with target_hash.
+     * @param {string} params.targetHash  - The unique hash identifier of the cast that received the reactions. This is a 40-character hexadecimal string prefixed with '0x' that uniquely identifies the cast within the creator's posts. Must be used with target_fid.
+     * @param {ReactionType} params.reactionType
      * @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
@@ -685,13 +685,13 @@ const client = new NeynarHubClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch reactions by a target URL.
+     * 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 {object} params
-     * @param {string} params.url  - The URL of the parent cast
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {string} params.url  - Target URL starting with 'chain://'.
+     * @param {ReactionType} params.reactionType
      * @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
@@ -727,7 +727,7 @@ const client = new NeynarHubClient(config);\n`);
      *
      * @param {object} params
      * @param {number} params.fid  - The FID of the reaction's creator
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {ReactionType} params.reactionType
      * @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
@@ -765,7 +765,7 @@ const client = new NeynarHubClient(config);\n`);
      * @param {number} params.fid  - The FID of the reaction's creator
      * @param {number} params.targetFid  - The FID of the cast's creator
      * @param {string} params.targetHash  - The cast's hash
-     * @param {ReactionType} params.reactionType  - The type of reaction, either as a numerical enum value or string representation
+     * @param {ReactionType} params.reactionType
      *
      * @returns {Promise<Reaction>} A promise that resolves to a `Reaction` object.
      *

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

@@ -2,7 +2,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/hub-api/api.js

@@ -5,7 +5,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,7 @@ import type { Configuration } from '../configuration';
 import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
 import { type RequestArgs, BaseAPI } from '../base';
 import type { CastAdd } from '../models';
+import type { FetchCastsByParent200Response } from '../models';
 import type { FetchUsersCasts200Response } from '../models';
 /**
  * CastsApi - axios parameter creator
@@ -20,17 +21,17 @@ import type { FetchUsersCasts200Response } from '../models';
  */
 export declare const CastsApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      * @summary By parent cast
-     * @param {number} [fid] The FID of the parent cast
-     * @param {string} [hash] The parent cast\'s hash
-     * @param {string} [url]
+     * @param {number} [fid] The Farcaster ID (FID) of the parent cast\'s creator. This parameter must be used together with the \'hash\' parameter to uniquely identify a parent cast. Required only when using hash-based lookup instead of URL-based lookup. The FID is a unique identifier assigned to each Farcaster user.
+     * @param {string} [hash] The unique hash identifier of the parent cast. Must be used together with the \'fid\' parameter when doing hash-based lookup. This is a 40-character hexadecimal string prefixed with \'0x\' that uniquely identifies the cast within the creator\'s posts. Not required if using URL-based lookup.
+     * @param {string} [url] Cast URL starting with \'chain://\'
      * @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
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
      *
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
      *
@@ -70,7 +71,7 @@ export declare const CastsApiAxiosParamCreator: (configuration?: Configuration)
      * Lookup a cast by its FID and hash.
      * @summary By FID and Hash
      * @param {number} fid The FID of the cast\&#39;s creator
-     * @param {string} hash The cast\&#39;s hash
+     * @param {string} hash The unique hash identifier of the cast. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies a specific cast in the Farcaster network.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<CastAdd>} A promise that resolves to a `CastAdd` object
@@ -86,22 +87,22 @@ export declare const CastsApiAxiosParamCreator: (configuration?: Configuration)
  */
 export declare const CastsApiFp: (configuration?: Configuration) => {
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      * @summary By parent cast
-     * @param {number} [fid] The FID of the parent cast
-     * @param {string} [hash] The parent cast\&#39;s hash
-     * @param {string} [url]
+     * @param {number} [fid] The Farcaster ID (FID) of the parent cast\&#39;s creator. This parameter must be used together with the \&#39;hash\&#39; parameter to uniquely identify a parent cast. Required only when using hash-based lookup instead of URL-based lookup. The FID is a unique identifier assigned to each Farcaster user.
+     * @param {string} [hash] The unique hash identifier of the parent cast. Must be used together with the \&#39;fid\&#39; parameter when doing hash-based lookup. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies the cast within the creator\&#39;s posts. Not required if using URL-based lookup.
+     * @param {string} [url] Cast URL starting with \&#39;chain://\&#39;
      * @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
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
      *
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
      *
      */
-    fetchCastsByParent(fid?: number, hash?: string, url?: string, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchUsersCasts200Response>>;
+    fetchCastsByParent(fid?: number, hash?: string, url?: string, pageSize?: number, reverse?: boolean, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchCastsByParent200Response>>;
     /**
      * Fetch casts mentioning a user.
      * @summary Mentioning an FID
@@ -136,7 +137,7 @@ export declare const CastsApiFp: (configuration?: Configuration) => {
      * Lookup a cast by its FID and hash.
      * @summary By FID and Hash
      * @param {number} fid The FID of the cast\&#39;s creator
-     * @param {string} hash The cast\&#39;s hash
+     * @param {string} hash The unique hash identifier of the cast. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies a specific cast in the Farcaster network.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @returns {Promise<CastAdd>} A promise that resolves to a `CastAdd` object
@@ -152,17 +153,17 @@ export declare const CastsApiFp: (configuration?: Configuration) => {
  */
 export declare const CastsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      * @summary By parent cast
      * @param {CastsApiFetchCastsByParentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
      *
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
      *
      */
-    fetchCastsByParent(requestParameters?: CastsApiFetchCastsByParentRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchUsersCasts200Response>;
+    fetchCastsByParent(requestParameters?: CastsApiFetchCastsByParentRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchCastsByParent200Response>;
     /**
      * Fetch casts mentioning a user.
      * @summary Mentioning an FID
@@ -207,18 +208,18 @@ export declare const CastsApiFactory: (configuration?: Configuration, basePath?:
  */
 export interface CastsApiInterface {
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      * @summary By parent cast
      * @param {CastsApiFetchCastsByParentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CastsApiInterface
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
      *
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
      *
      */
-    fetchCastsByParent(requestParameters?: CastsApiFetchCastsByParentRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchUsersCasts200Response>;
+    fetchCastsByParent(requestParameters?: CastsApiFetchCastsByParentRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchCastsByParent200Response>;
     /**
      * Fetch casts mentioning a user.
      * @summary Mentioning an FID
@@ -266,7 +267,7 @@ export interface CastsApiInterface {
  */
 export interface CastsApiFetchCastsByParentRequest {
     /**
-     * The FID of the parent cast
+     * The Farcaster ID (FID) of the parent cast\&#39;s creator. This parameter must be used together with the \&#39;hash\&#39; parameter to uniquely identify a parent cast. Required only when using hash-based lookup instead of URL-based lookup. The FID is a unique identifier assigned to each Farcaster user.
      *
      *
      *
@@ -275,7 +276,7 @@ export interface CastsApiFetchCastsByParentRequest {
      */
     readonly fid?: number;
     /**
-     * The parent cast\&#39;s hash
+     * The unique hash identifier of the parent cast. Must be used together with the \&#39;fid\&#39; parameter when doing hash-based lookup. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies the cast within the creator\&#39;s posts. Not required if using URL-based lookup.
      *
      *
      *
@@ -284,7 +285,7 @@ export interface CastsApiFetchCastsByParentRequest {
      */
     readonly hash?: string;
     /**
-     *
+     * Cast URL starting with \&#39;chain://\&#39;
      *
      *
      *
@@ -422,7 +423,7 @@ export interface CastsApiLookupCastByHashAndFidRequest {
      */
     readonly fid: number;
     /**
-     * The cast\&#39;s hash
+     * The unique hash identifier of the cast. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies a specific cast in the Farcaster network.
      *
      *
      *
@@ -439,18 +440,18 @@ export interface CastsApiLookupCastByHashAndFidRequest {
  */
 export declare class CastsApi extends BaseAPI implements CastsApiInterface {
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      * @summary By parent cast
      * @param {CastsApiFetchCastsByParentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CastsApi
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
      *
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
      *
      */
-    fetchCastsByParent(requestParameters?: CastsApiFetchCastsByParentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchUsersCasts200Response, any>>;
+    fetchCastsByParent(requestParameters?: CastsApiFetchCastsByParentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchCastsByParent200Response, any>>;
     /**
      * Fetch casts mentioning a user.
      * @summary Mentioning an FID

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

@@ -5,7 +5,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,17 +30,17 @@ const base_1 = require("../base");
 const CastsApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Fetch casts by parent.
+         * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
          * @summary By parent cast
-         * @param {number} [fid] The FID of the parent cast
-         * @param {string} [hash] The parent cast\'s hash
-         * @param {string} [url]
+         * @param {number} [fid] The Farcaster ID (FID) of the parent cast\'s creator. This parameter must be used together with the \'hash\' parameter to uniquely identify a parent cast. Required only when using hash-based lookup instead of URL-based lookup. The FID is a unique identifier assigned to each Farcaster user.
+         * @param {string} [hash] The unique hash identifier of the parent cast. Must be used together with the \'fid\' parameter when doing hash-based lookup. This is a 40-character hexadecimal string prefixed with \'0x\' that uniquely identifies the cast within the creator\'s posts. Not required if using URL-based lookup.
+         * @param {string} [url] Cast URL starting with \'chain://\'
          * @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
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
-         * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+         * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
          *
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
          *
@@ -186,7 +186,7 @@ const CastsApiAxiosParamCreator = function (configuration) {
          * Lookup a cast by its FID and hash.
          * @summary By FID and Hash
          * @param {number} fid The FID of the cast\&#39;s creator
-         * @param {string} hash The cast\&#39;s hash
+         * @param {string} hash The unique hash identifier of the cast. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies a specific cast in the Farcaster network.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<CastAdd>} A promise that resolves to a `CastAdd` object
@@ -236,17 +236,17 @@ const CastsApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.CastsApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Fetch casts by parent.
+         * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
          * @summary By parent cast
-         * @param {number} [fid] The FID of the parent cast
-         * @param {string} [hash] The parent cast\&#39;s hash
-         * @param {string} [url]
+         * @param {number} [fid] The Farcaster ID (FID) of the parent cast\&#39;s creator. This parameter must be used together with the \&#39;hash\&#39; parameter to uniquely identify a parent cast. Required only when using hash-based lookup instead of URL-based lookup. The FID is a unique identifier assigned to each Farcaster user.
+         * @param {string} [hash] The unique hash identifier of the parent cast. Must be used together with the \&#39;fid\&#39; parameter when doing hash-based lookup. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies the cast within the creator\&#39;s posts. Not required if using URL-based lookup.
+         * @param {string} [url] Cast URL starting with \&#39;chain://\&#39;
          * @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
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
-         * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+         * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
          *
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
          *
@@ -304,7 +304,7 @@ const CastsApiFp = function (configuration) {
          * Lookup a cast by its FID and hash.
          * @summary By FID and Hash
          * @param {number} fid The FID of the cast\&#39;s creator
-         * @param {string} hash The cast\&#39;s hash
+         * @param {string} hash The unique hash identifier of the cast. This is a 40-character hexadecimal string prefixed with \&#39;0x\&#39; that uniquely identifies a specific cast in the Farcaster network.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<CastAdd>} A promise that resolves to a `CastAdd` object
@@ -330,12 +330,12 @@ const CastsApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.CastsApiFp)(configuration);
     return {
         /**
-         * Fetch casts by parent.
+         * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
          * @summary By parent cast
          * @param {CastsApiFetchCastsByParentRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
-         * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+         * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
          *
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
          *
@@ -396,13 +396,13 @@ exports.CastsApiFactory = CastsApiFactory;
  */
 class CastsApi extends base_1.BaseAPI {
     /**
-     * Fetch casts by parent.
+     * Retrieve all reply casts (responses) to a specific parent cast in the Farcaster network. Parent casts can be identified using either a combination of FID and hash, or by their URL. This endpoint enables traversal of conversation threads and retrieval of all responses to a particular cast.
      * @summary By parent cast
      * @param {CastsApiFetchCastsByParentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof CastsApi
-     * @returns {Promise<FetchUsersCasts200Response>} A promise that resolves to a `FetchUsersCasts200Response` object
+     * @returns {Promise<FetchCastsByParent200Response>} A promise that resolves to a `FetchCastsByParent200Response` object
      *
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-casts-by-parent)
      *

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

@@ -2,7 +2,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -5,7 +5,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -5,7 +5,7 @@
  * Farcaster Hub API
  * Perform basic queries of Farcaster state via the REST API of a Farcaster hub. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.7.1
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).