@neynar/nodejs-sdk 2.31.0 → 2.33.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.31.0
+ * The version of the OpenAPI document: 2.33.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,8 +30,8 @@ const base_1 = require("../base");
 const FrameApiAxiosParamCreator = function (configuration) {
     return {
         /**
-         * Delete an existing frame, if it was made by the developer (identified by API key)
-         * @summary Delete frame
+         * Delete an existing mini app, if it was made by the developer (identified by API key)
+         * @summary Delete mini app
          * @param {DeleteFrameReqBody} deleteFrameReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -66,11 +66,11 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * A curated list of featured frames
-         * @summary Frames Catalog
+         * A curated list of featured mini apps
+         * @summary Mini apps 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 {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
@@ -107,9 +107,9 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Fetches the frame meta tags from the URL
+         * Fetches the mini app meta tags from the URL
          * @summary Meta tags from URL
-         * @param {string} url The frame URL to crawl
+         * @param {string} url The mini app URL to crawl
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FetchFrameMetaTagsFromUrl200Response>} A promise that resolves to a `FetchFrameMetaTagsFromUrl200Response` object
@@ -144,8 +144,8 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Fetch a list of frames made by the developer (identified by API key)
-         * @summary List of frames
+         * Fetch a list of mini apps made by the developer (identified by API key)
+         * @summary List of mini apps
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
@@ -175,8 +175,8 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Returns a list of notifications tokens related for an app
-         * @summary List of frame notification tokens
+         * Returns a list of notifications tokens related to a mini app
+         * @summary List of mini app notification tokens
          * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
          * @param {string} [fids] Comma separated list of FIDs, up to 100 at a time
          * @param {string} [cursor] Pagination cursor
@@ -218,14 +218,16 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * 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
+         * Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
+         * @summary Relevant mini apps
+         * @param {number} viewerFid FID of the user to fetch relevant mini apps for
+         * @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate mini app relevance
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
+         *
          */
         fetchRelevantFrames: async (viewerFid, timeWindow, options = {}) => {
             // verify required parameter 'viewerFid' is not null or undefined
@@ -258,7 +260,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         },
         /**
          * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
-         * @summary Analytics for the frame
+         * @summary Analytics for the mini app
          * @param {string} frameUrl
          * @param {ValidateFrameAnalyticsType} analyticsType
          * @param {string} start
@@ -320,8 +322,8 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Fetch a list of all the frames validated by a user
-         * @summary All frames validated by user
+         * Fetch a list of all the mini apps validated by a user
+         * @summary All mini apps validated by user
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object
@@ -351,9 +353,9 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Retrieves details about a transaction pay frame by ID
-         * @summary Get transaction pay frame
-         * @param {string} id ID of the transaction frame to retrieve
+         * Retrieves details about a transaction pay mini app by ID
+         * @summary Get transaction pay mini app
+         * @param {string} id ID of the transaction mini app to retrieve
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
@@ -386,11 +388,11 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Fetch a frame either by UUID or Neynar URL
-         * @summary Frame by UUID or URL
+         * Fetch a mini app either by UUID or Neynar URL
+         * @summary Mini app by UUID or URL
          * @param {FrameType} type
-         * @param {string} [uuid] UUID of the frame to fetch
-         * @param {string} [url] URL of the Neynar frame to fetch
+         * @param {string} [uuid] UUID of the mini app to fetch
+         * @param {string} [url] URL of the Neynar mini app to fetch
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object
@@ -431,8 +433,8 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Post frame actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for frames.
-         * @summary Post a frame action, cast action or a cast composer action
+         * Post mini app actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for mini apps.
+         * @summary Post a mini app action, cast action or a cast composer action
          * @param {FrameActionReqBody} frameActionReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -467,7 +469,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Post a frame action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
+         * Post a mini app action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
          * @summary Signature packet
          * @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody
          * @param {*} [options] Override http request option.
@@ -503,7 +505,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Send notifications to interactors of a frame
+         * Send notifications to interactors of a mini app
          * @summary Send notifications
          * @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
          * @param {*} [options] Override http request option.
@@ -539,8 +541,8 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Create a new frame with a list of pages.
-         * @summary Create frame
+         * Create a new mini app with a list of pages.
+         * @summary Create mini app
          * @param {NeynarFrameCreationReqBody} neynarFrameCreationReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -575,8 +577,8 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Update an existing frame with a list of pages, if it was made by the developer (identified by API key)
-         * @summary Update frame
+         * Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
+         * @summary Update mini app
          * @param {NeynarFrameUpdateReqBody} neynarFrameUpdateReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -611,8 +613,8 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex)
-         * @summary Validate frame action
+         * Validates a mini app against by an interacting user against a Farcaster Hub \\ (In order to validate a mini app, message bytes from Frame Action must be provided in hex)
+         * @summary Validate mini app action
          * @param {ValidateFrameActionReqBody} validateFrameActionReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -657,8 +659,8 @@ const FrameApiFp = function (configuration) {
     const localVarAxiosParamCreator = (0, exports.FrameApiAxiosParamCreator)(configuration);
     return {
         /**
-         * Delete an existing frame, if it was made by the developer (identified by API key)
-         * @summary Delete frame
+         * Delete an existing mini app, if it was made by the developer (identified by API key)
+         * @summary Delete mini app
          * @param {DeleteFrameReqBody} deleteFrameReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -675,11 +677,11 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * A curated list of featured frames
-         * @summary Frames Catalog
+         * A curated list of featured mini apps
+         * @summary Mini apps 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 {TrendingTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
@@ -693,9 +695,9 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Fetches the frame meta tags from the URL
+         * Fetches the mini app meta tags from the URL
          * @summary Meta tags from URL
-         * @param {string} url The frame URL to crawl
+         * @param {string} url The mini app URL to crawl
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FetchFrameMetaTagsFromUrl200Response>} A promise that resolves to a `FetchFrameMetaTagsFromUrl200Response` object
@@ -711,8 +713,8 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Fetch a list of frames made by the developer (identified by API key)
-         * @summary List of frames
+         * Fetch a list of mini apps made by the developer (identified by API key)
+         * @summary List of mini apps
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
@@ -728,8 +730,8 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Returns a list of notifications tokens related for an app
-         * @summary List of frame notification tokens
+         * Returns a list of notifications tokens related to a mini app
+         * @summary List of mini app notification tokens
          * @param {number} [limit] Number of results to fetch  (Default: 20, Maximum: 100)
          * @param {string} [fids] Comma separated list of FIDs, up to 100 at a time
          * @param {string} [cursor] Pagination cursor
@@ -748,14 +750,16 @@ const FrameApiFp = function (configuration) {
             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
+         * Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
+         * @summary Relevant mini apps
+         * @param {number} viewerFid FID of the user to fetch relevant mini apps for
+         * @param {TrendingTimeWindow} [timeWindow] Time window used to limit statistics used to calculate mini app relevance
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
+         *
          */
         async fetchRelevantFrames(viewerFid, timeWindow, options) {
             var _a, _b, _c;
@@ -766,7 +770,7 @@ const FrameApiFp = function (configuration) {
         },
         /**
          * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
-         * @summary Analytics for the frame
+         * @summary Analytics for the mini app
          * @param {string} frameUrl
          * @param {ValidateFrameAnalyticsType} analyticsType
          * @param {string} start
@@ -787,8 +791,8 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Fetch a list of all the frames validated by a user
-         * @summary All frames validated by user
+         * Fetch a list of all the mini apps validated by a user
+         * @summary All mini apps validated by user
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object
@@ -804,9 +808,9 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Retrieves details about a transaction pay frame by ID
-         * @summary Get transaction pay frame
-         * @param {string} id ID of the transaction frame to retrieve
+         * Retrieves details about a transaction pay mini app by ID
+         * @summary Get transaction pay mini app
+         * @param {string} id ID of the transaction mini app to retrieve
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
@@ -820,11 +824,11 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Fetch a frame either by UUID or Neynar URL
-         * @summary Frame by UUID or URL
+         * Fetch a mini app either by UUID or Neynar URL
+         * @summary Mini app by UUID or URL
          * @param {FrameType} type
-         * @param {string} [uuid] UUID of the frame to fetch
-         * @param {string} [url] URL of the Neynar frame to fetch
+         * @param {string} [uuid] UUID of the mini app to fetch
+         * @param {string} [url] URL of the Neynar mini app to fetch
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object
@@ -840,8 +844,8 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Post frame actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for frames.
-         * @summary Post a frame action, cast action or a cast composer action
+         * Post mini app actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for mini apps.
+         * @summary Post a mini app action, cast action or a cast composer action
          * @param {FrameActionReqBody} frameActionReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -858,7 +862,7 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Post a frame action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
+         * Post a mini app action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
          * @summary Signature packet
          * @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody
          * @param {*} [options] Override http request option.
@@ -876,7 +880,7 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Send notifications to interactors of a frame
+         * Send notifications to interactors of a mini app
          * @summary Send notifications
          * @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
          * @param {*} [options] Override http request option.
@@ -894,8 +898,8 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Create a new frame with a list of pages.
-         * @summary Create frame
+         * Create a new mini app with a list of pages.
+         * @summary Create mini app
          * @param {NeynarFrameCreationReqBody} neynarFrameCreationReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -912,8 +916,8 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Update an existing frame with a list of pages, if it was made by the developer (identified by API key)
-         * @summary Update frame
+         * Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
+         * @summary Update mini app
          * @param {NeynarFrameUpdateReqBody} neynarFrameUpdateReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -930,8 +934,8 @@ const FrameApiFp = function (configuration) {
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex)
-         * @summary Validate frame action
+         * Validates a mini app against by an interacting user against a Farcaster Hub \\ (In order to validate a mini app, message bytes from Frame Action must be provided in hex)
+         * @summary Validate mini app action
          * @param {ValidateFrameActionReqBody} validateFrameActionReqBody
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -958,8 +962,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
     const localVarFp = (0, exports.FrameApiFp)(configuration);
     return {
         /**
-         * Delete an existing frame, if it was made by the developer (identified by API key)
-         * @summary Delete frame
+         * Delete an existing mini app, if it was made by the developer (identified by API key)
+         * @summary Delete mini app
          * @param {FrameApiDeleteNeynarFrameRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -972,8 +976,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.deleteNeynarFrame(requestParameters.deleteFrameReqBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * A curated list of featured frames
-         * @summary Frames Catalog
+         * A curated list of featured mini apps
+         * @summary Mini apps catalog
          * @param {FrameApiFetchFrameCatalogRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -984,7 +988,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.fetchFrameCatalog(requestParameters.limit, requestParameters.cursor, requestParameters.timeWindow, options).then((request) => request(axios, basePath));
         },
         /**
-         * Fetches the frame meta tags from the URL
+         * Fetches the mini app meta tags from the URL
          * @summary Meta tags from URL
          * @param {FrameApiFetchFrameMetaTagsFromUrlRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -998,8 +1002,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.fetchFrameMetaTagsFromUrl(requestParameters.url, options).then((request) => request(axios, basePath));
         },
         /**
-         * Fetch a list of frames made by the developer (identified by API key)
-         * @summary List of frames
+         * Fetch a list of mini apps made by the developer (identified by API key)
+         * @summary List of mini apps
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
@@ -1011,8 +1015,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.fetchNeynarFrames(options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of notifications tokens related for an app
-         * @summary List of frame notification tokens
+         * Returns a list of notifications tokens related to a mini app
+         * @summary List of mini app notification tokens
          * @param {FrameApiFetchNotificationTokensRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1025,20 +1029,22 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             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
+         * Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
+         * @summary Relevant mini apps
          * @param {FrameApiFetchRelevantFramesRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
+         *
          */
         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
+         * @summary Analytics for the mini app
          * @param {FrameApiFetchValidateFrameAnalyticsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1051,8 +1057,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.fetchValidateFrameAnalytics(requestParameters.frameUrl, requestParameters.analyticsType, requestParameters.start, requestParameters.stop, requestParameters.aggregateWindow, options).then((request) => request(axios, basePath));
         },
         /**
-         * Fetch a list of all the frames validated by a user
-         * @summary All frames validated by user
+         * Fetch a list of all the mini apps validated by a user
+         * @summary All mini apps validated by user
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object
@@ -1064,8 +1070,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.fetchValidateFrameList(options).then((request) => request(axios, basePath));
         },
         /**
-         * Retrieves details about a transaction pay frame by ID
-         * @summary Get transaction pay frame
+         * Retrieves details about a transaction pay mini app by ID
+         * @summary Get transaction pay mini app
          * @param {FrameApiGetTransactionPayFrameRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1076,8 +1082,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getTransactionPayFrame(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Fetch a frame either by UUID or Neynar URL
-         * @summary Frame by UUID or URL
+         * Fetch a mini app either by UUID or Neynar URL
+         * @summary Mini app by UUID or URL
          * @param {FrameApiLookupNeynarFrameRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1090,8 +1096,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.lookupNeynarFrame(requestParameters.type, requestParameters.uuid, requestParameters.url, options).then((request) => request(axios, basePath));
         },
         /**
-         * Post frame actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for frames.
-         * @summary Post a frame action, cast action or a cast composer action
+         * Post mini app actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for mini apps.
+         * @summary Post a mini app action, cast action or a cast composer action
          * @param {FrameApiPostFrameActionRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1104,7 +1110,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.postFrameAction(requestParameters.frameActionReqBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * Post a frame action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
+         * Post a mini app action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
          * @summary Signature packet
          * @param {FrameApiPostFrameActionDeveloperManagedRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -1118,7 +1124,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.postFrameActionDeveloperManaged(requestParameters.frameDeveloperManagedActionReqBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * Send notifications to interactors of a frame
+         * Send notifications to interactors of a mini app
          * @summary Send notifications
          * @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -1132,8 +1138,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.publishFrameNotifications(requestParameters.sendFrameNotificationsReqBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * Create a new frame with a list of pages.
-         * @summary Create frame
+         * Create a new mini app with a list of pages.
+         * @summary Create mini app
          * @param {FrameApiPublishNeynarFrameRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1146,8 +1152,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.publishNeynarFrame(requestParameters.neynarFrameCreationReqBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * Update an existing frame with a list of pages, if it was made by the developer (identified by API key)
-         * @summary Update frame
+         * Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
+         * @summary Update mini app
          * @param {FrameApiUpdateNeynarFrameRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1160,8 +1166,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.updateNeynarFrame(requestParameters.neynarFrameUpdateReqBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex)
-         * @summary Validate frame action
+         * Validates a mini app against by an interacting user against a Farcaster Hub \\ (In order to validate a mini app, message bytes from Frame Action must be provided in hex)
+         * @summary Validate mini app action
          * @param {FrameApiValidateFrameActionRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -1184,8 +1190,8 @@ exports.FrameApiFactory = FrameApiFactory;
  */
 class FrameApi extends base_1.BaseAPI {
     /**
-     * Delete an existing frame, if it was made by the developer (identified by API key)
-     * @summary Delete frame
+     * Delete an existing mini app, if it was made by the developer (identified by API key)
+     * @summary Delete mini app
      * @param {FrameApiDeleteNeynarFrameRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1199,8 +1205,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).deleteNeynarFrame(requestParameters.deleteFrameReqBody, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * A curated list of featured frames
-     * @summary Frames Catalog
+     * A curated list of featured mini apps
+     * @summary Mini apps catalog
      * @param {FrameApiFetchFrameCatalogRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1212,7 +1218,7 @@ class FrameApi extends base_1.BaseAPI {
         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
+     * Fetches the mini app meta tags from the URL
      * @summary Meta tags from URL
      * @param {FrameApiFetchFrameMetaTagsFromUrlRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -1227,8 +1233,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).fetchFrameMetaTagsFromUrl(requestParameters.url, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Fetch a list of frames made by the developer (identified by API key)
-     * @summary List of frames
+     * Fetch a list of mini apps made by the developer (identified by API key)
+     * @summary List of mini apps
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FrameApi
@@ -1241,8 +1247,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).fetchNeynarFrames(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Returns a list of notifications tokens related for an app
-     * @summary List of frame notification tokens
+     * Returns a list of notifications tokens related to a mini app
+     * @summary List of mini app notification tokens
      * @param {FrameApiFetchNotificationTokensRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1256,21 +1262,23 @@ class FrameApi extends base_1.BaseAPI {
         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
+     * Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
+     * @summary Relevant mini apps
      * @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
      *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
+     *
      */
     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
+     * @summary Analytics for the mini app
      * @param {FrameApiFetchValidateFrameAnalyticsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1284,8 +1292,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).fetchValidateFrameAnalytics(requestParameters.frameUrl, requestParameters.analyticsType, requestParameters.start, requestParameters.stop, requestParameters.aggregateWindow, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Fetch a list of all the frames validated by a user
-     * @summary All frames validated by user
+     * Fetch a list of all the mini apps validated by a user
+     * @summary All mini apps validated by user
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof FrameApi
@@ -1298,8 +1306,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).fetchValidateFrameList(options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Retrieves details about a transaction pay frame by ID
-     * @summary Get transaction pay frame
+     * Retrieves details about a transaction pay mini app by ID
+     * @summary Get transaction pay mini app
      * @param {FrameApiGetTransactionPayFrameRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1311,8 +1319,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).getTransactionPayFrame(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Fetch a frame either by UUID or Neynar URL
-     * @summary Frame by UUID or URL
+     * Fetch a mini app either by UUID or Neynar URL
+     * @summary Mini app by UUID or URL
      * @param {FrameApiLookupNeynarFrameRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1326,8 +1334,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).lookupNeynarFrame(requestParameters.type, requestParameters.uuid, requestParameters.url, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Post frame actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for frames.
-     * @summary Post a frame action, cast action or a cast composer action
+     * Post mini app actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for mini apps.
+     * @summary Post a mini app action, cast action or a cast composer action
      * @param {FrameApiPostFrameActionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1341,7 +1349,7 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).postFrameAction(requestParameters.frameActionReqBody, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Post a frame action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
+     * Post a mini app action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
      * @summary Signature packet
      * @param {FrameApiPostFrameActionDeveloperManagedRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -1356,7 +1364,7 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).postFrameActionDeveloperManaged(requestParameters.frameDeveloperManagedActionReqBody, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Send notifications to interactors of a frame
+     * Send notifications to interactors of a mini app
      * @summary Send notifications
      * @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -1371,8 +1379,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).publishFrameNotifications(requestParameters.sendFrameNotificationsReqBody, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Create a new frame with a list of pages.
-     * @summary Create frame
+     * Create a new mini app with a list of pages.
+     * @summary Create mini app
      * @param {FrameApiPublishNeynarFrameRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1386,8 +1394,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).publishNeynarFrame(requestParameters.neynarFrameCreationReqBody, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Update an existing frame with a list of pages, if it was made by the developer (identified by API key)
-     * @summary Update frame
+     * Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
+     * @summary Update mini app
      * @param {FrameApiUpdateNeynarFrameRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -1401,8 +1409,8 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).updateNeynarFrame(requestParameters.neynarFrameUpdateReqBody, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex)
-     * @summary Validate frame action
+     * Validates a mini app against by an interacting user against a Farcaster Hub \\ (In order to validate a mini app, message bytes from Frame Action must be provided in hex)
+     * @summary Validate mini app action
      * @param {FrameApiValidateFrameActionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}