@neynar/nodejs-sdk 2.44.0 → 3.18.0

package/build/api/apis/frame-api.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * 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.
+ * Neynar API
+ * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.44.0
+ * The version of the OpenAPI document: 3.18.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FetchFrameCatalogCategoriesEnum = exports.FrameApi = exports.FrameApiFactory = exports.FrameApiFp = exports.FrameApiAxiosParamCreator = void 0;
+exports.LookupNeynarFrameTypeEnum = exports.FetchValidateFrameAnalyticsAggregateWindowEnum = exports.FetchValidateFrameAnalyticsAnalyticsTypeEnum = exports.FetchRelevantFramesTimeWindowEnum = exports.FetchFrameCatalogCategoriesEnum = exports.FetchFrameCatalogTimeWindowEnum = exports.FrameApi = exports.FrameApiFactory = exports.FrameApiFp = exports.FrameApiAxiosParamCreator = void 0;
 const axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -43,7 +43,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         deleteNeynarFrame: async (deleteFrameReqBody, options = {}) => {
             // verify required parameter 'deleteFrameReqBody' is not null or undefined
             (0, common_1.assertParamExists)('deleteNeynarFrame', 'deleteFrameReqBody', deleteFrameReqBody);
-            const localVarPath = `/farcaster/frame`;
+            const localVarPath = `/v2/farcaster/frame/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -70,15 +70,17 @@ const FrameApiAxiosParamCreator = function (configuration) {
          * @summary Mini apps catalog
          * @param {number} [limit] Number of results to fetch  (Default: 100, Maximum: 100)
          * @param {string} [cursor] Pagination cursor
-         * @param {MiniAppTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
-         * @param {Array<FetchFrameCatalogCategoriesEnum>} [categories] Comma separated list of categories to include in the results.  Includes all if left blank.  Example: &#x60;categories&#x3D;games,social&#x60; OR: &#x60;categories&#x3D;games&amp;categories&#x3D;social&#x60;
+         * @param {FetchFrameCatalogTimeWindowEnum} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
+         * @param {Array<FetchFrameCatalogCategoriesEnum>} [categories] Comma separated list of categories to include in the results. Includes all if left blank. Example: categories&#x3D;games,social OR categories&#x3D;games&amp;categories&#x3D;social
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-catalog)
+         *
          */
         fetchFrameCatalog: async (limit, cursor, timeWindow, categories, options = {}) => {
-            const localVarPath = `/farcaster/frame/catalog`;
+            const localVarPath = `/v2/farcaster/frame/catalog/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -100,7 +102,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['time_window'] = timeWindow;
             }
             if (categories) {
-                localVarQueryParameter['categories'] = categories.join(base_1.COLLECTION_FORMATS.csv);
+                localVarQueryParameter['categories'] = categories;
             }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -124,7 +126,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         fetchFrameMetaTagsFromUrl: async (url, options = {}) => {
             // verify required parameter 'url' is not null or undefined
             (0, common_1.assertParamExists)('fetchFrameMetaTagsFromUrl', 'url', url);
-            const localVarPath = `/farcaster/frame/crawl`;
+            const localVarPath = `/v2/farcaster/frame/crawl/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -158,7 +160,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
          *
          */
         fetchNeynarFrames: async (options = {}) => {
-            const localVarPath = `/farcaster/frame/list`;
+            const localVarPath = `/v2/farcaster/frame/list/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -192,7 +194,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
          *
          */
         fetchNotificationTokens: async (limit, fids, cursor, options = {}) => {
-            const localVarPath = `/farcaster/frame/notification_tokens`;
+            const localVarPath = `/v2/farcaster/frame/notification_tokens/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -225,18 +227,18 @@ const FrameApiAxiosParamCreator = function (configuration) {
          * 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 {MiniAppTimeWindow} [timeWindow] Time window used to limit statistics used to calculate mini app relevance
+         * @param {FetchRelevantFramesTimeWindowEnum} [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)
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-frames)
          *
          */
         fetchRelevantFrames: async (viewerFid, timeWindow, options = {}) => {
             // verify required parameter 'viewerFid' is not null or undefined
             (0, common_1.assertParamExists)('fetchRelevantFrames', 'viewerFid', viewerFid);
-            const localVarPath = `/farcaster/frame/relevant`;
+            const localVarPath = `/v2/farcaster/frame/relevant/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -265,11 +267,11 @@ const FrameApiAxiosParamCreator = function (configuration) {
         /**
          * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
          * @summary Analytics for the mini app
-         * @param {string} frameUrl
-         * @param {ValidateFrameAnalyticsType} analyticsType
+         * @param {string} frameUrl URL of the mini app to fetch analytics for
+         * @param {FetchValidateFrameAnalyticsAnalyticsTypeEnum} analyticsType Type of analytics to fetch
          * @param {string} start
          * @param {string} stop
-         * @param {ValidateFrameAggregateWindow} [aggregateWindow] Required for &#x60;analytics_type&#x3D;interactions-per-cast&#x60;
+         * @param {FetchValidateFrameAnalyticsAggregateWindowEnum} [aggregateWindow] Required for &#x60;analytics_type&#x3D;interactions-per-cast&#x60;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameValidateAnalyticsResponse>} A promise that resolves to a `FrameValidateAnalyticsResponse` object
@@ -286,7 +288,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
             (0, common_1.assertParamExists)('fetchValidateFrameAnalytics', 'start', start);
             // verify required parameter 'stop' is not null or undefined
             (0, common_1.assertParamExists)('fetchValidateFrameAnalytics', 'stop', stop);
-            const localVarPath = `/farcaster/frame/validate/analytics`;
+            const localVarPath = `/v2/farcaster/frame/validate/analytics/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -336,7 +338,41 @@ const FrameApiAxiosParamCreator = function (configuration) {
          *
          */
         fetchValidateFrameList: async (options = {}) => {
-            const localVarPath = `/farcaster/frame/validate/list`;
+            const localVarPath = `/v2/farcaster/frame/validate/list/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieve notification delivery and opened stats for notification campaigns
+         * @summary Get notification campaign stats
+         * @param {string} [campaignId] An ID of a specific notification campaign to query
+         * @param {number} [limit] The number of results to return  (Default: 100, Maximum: 1000)
+         * @param {string} [cursor] Pagination cursor
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         * @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object
+         *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-notification-campaign-stats)
+         *
+         */
+        getNotificationCampaignStats: async (campaignId, limit, cursor, options = {}) => {
+            const localVarPath = `/v2/farcaster/frame/notifications/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -348,6 +384,15 @@ const FrameApiAxiosParamCreator = function (configuration) {
             const localVarQueryParameter = {};
             // authentication ApiKeyAuth required
             await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
+            if (campaignId !== undefined) {
+                localVarQueryParameter['campaign_id'] = campaignId;
+            }
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (cursor !== undefined) {
+                localVarQueryParameter['cursor'] = cursor;
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -364,11 +409,13 @@ const FrameApiAxiosParamCreator = function (configuration) {
          * @throws {RequiredError}
          * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-transaction-pay-frame)
+         *
          */
         getTransactionPayFrame: async (id, options = {}) => {
             // verify required parameter 'id' is not null or undefined
             (0, common_1.assertParamExists)('getTransactionPayFrame', 'id', id);
-            const localVarPath = `/farcaster/frame/transaction/pay`;
+            const localVarPath = `/v2/farcaster/frame/transaction/pay/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -394,7 +441,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         /**
          * Fetch a mini app either by UUID or Neynar URL
          * @summary Mini app by UUID or URL
-         * @param {FrameType} type
+         * @param {LookupNeynarFrameTypeEnum} type Type of identifier (either \&#39;uuid\&#39; or \&#39;url\&#39;)
          * @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.
@@ -407,7 +454,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         lookupNeynarFrame: async (type, uuid, url, options = {}) => {
             // verify required parameter 'type' is not null or undefined
             (0, common_1.assertParamExists)('lookupNeynarFrame', 'type', type);
-            const localVarPath = `/farcaster/frame`;
+            const localVarPath = `/v2/farcaster/frame/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -437,7 +484,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * 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.
+         * 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.
@@ -450,7 +497,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         postFrameAction: async (frameActionReqBody, options = {}) => {
             // verify required parameter 'frameActionReqBody' is not null or undefined
             (0, common_1.assertParamExists)('postFrameAction', 'frameActionReqBody', frameActionReqBody);
-            const localVarPath = `/farcaster/frame/action`;
+            const localVarPath = `/v2/farcaster/frame/action/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -486,7 +533,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         postFrameActionDeveloperManaged: async (frameDeveloperManagedActionReqBody, options = {}) => {
             // verify required parameter 'frameDeveloperManagedActionReqBody' is not null or undefined
             (0, common_1.assertParamExists)('postFrameActionDeveloperManaged', 'frameDeveloperManagedActionReqBody', frameDeveloperManagedActionReqBody);
-            const localVarPath = `/farcaster/frame/developer_managed/action`;
+            const localVarPath = `/v2/farcaster/frame/developer_managed/action/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -522,7 +569,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         publishFrameNotifications: async (sendFrameNotificationsReqBody, options = {}) => {
             // verify required parameter 'sendFrameNotificationsReqBody' is not null or undefined
             (0, common_1.assertParamExists)('publishFrameNotifications', 'sendFrameNotificationsReqBody', sendFrameNotificationsReqBody);
-            const localVarPath = `/farcaster/frame/notifications`;
+            const localVarPath = `/v2/farcaster/frame/notifications/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -558,7 +605,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         publishNeynarFrame: async (neynarFrameCreationReqBody, options = {}) => {
             // verify required parameter 'neynarFrameCreationReqBody' is not null or undefined
             (0, common_1.assertParamExists)('publishNeynarFrame', 'neynarFrameCreationReqBody', neynarFrameCreationReqBody);
-            const localVarPath = `/farcaster/frame`;
+            const localVarPath = `/v2/farcaster/frame/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -596,7 +643,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         searchFrames: async (q, limit, cursor, options = {}) => {
             // verify required parameter 'q' is not null or undefined
             (0, common_1.assertParamExists)('searchFrames', 'q', q);
-            const localVarPath = `/farcaster/frame/search`;
+            const localVarPath = `/v2/farcaster/frame/search/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -639,7 +686,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         updateNeynarFrame: async (neynarFrameUpdateReqBody, options = {}) => {
             // verify required parameter 'neynarFrameUpdateReqBody' is not null or undefined
             (0, common_1.assertParamExists)('updateNeynarFrame', 'neynarFrameUpdateReqBody', neynarFrameUpdateReqBody);
-            const localVarPath = `/farcaster/frame`;
+            const localVarPath = `/v2/farcaster/frame/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -662,7 +709,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * 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)
+         * 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.
@@ -675,7 +722,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
         validateFrameAction: async (validateFrameActionReqBody, options = {}) => {
             // verify required parameter 'validateFrameActionReqBody' is not null or undefined
             (0, common_1.assertParamExists)('validateFrameAction', 'validateFrameActionReqBody', validateFrameActionReqBody);
-            const localVarPath = `/farcaster/frame/validate`;
+            const localVarPath = `/v2/farcaster/frame/validate/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -730,12 +777,14 @@ const FrameApiFp = function (configuration) {
          * @summary Mini apps catalog
          * @param {number} [limit] Number of results to fetch  (Default: 100, Maximum: 100)
          * @param {string} [cursor] Pagination cursor
-         * @param {MiniAppTimeWindow} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
-         * @param {Array<FetchFrameCatalogCategoriesEnum>} [categories] Comma separated list of categories to include in the results.  Includes all if left blank.  Example: &#x60;categories&#x3D;games,social&#x60; OR: &#x60;categories&#x3D;games&amp;categories&#x3D;social&#x60;
+         * @param {FetchFrameCatalogTimeWindowEnum} [timeWindow] Time window used to calculate the change in trending score for each mini app, used to sort mini app results
+         * @param {Array<FetchFrameCatalogCategoriesEnum>} [categories] Comma separated list of categories to include in the results. Includes all if left blank. Example: categories&#x3D;games,social OR categories&#x3D;games&amp;categories&#x3D;social
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-catalog)
+         *
          */
         async fetchFrameCatalog(limit, cursor, timeWindow, categories, options) {
             var _a, _b, _c;
@@ -803,12 +852,12 @@ const FrameApiFp = function (configuration) {
          * 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 {MiniAppTimeWindow} [timeWindow] Time window used to limit statistics used to calculate mini app relevance
+         * @param {FetchRelevantFramesTimeWindowEnum} [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)
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-frames)
          *
          */
         async fetchRelevantFrames(viewerFid, timeWindow, options) {
@@ -821,11 +870,11 @@ const FrameApiFp = function (configuration) {
         /**
          * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
          * @summary Analytics for the mini app
-         * @param {string} frameUrl
-         * @param {ValidateFrameAnalyticsType} analyticsType
+         * @param {string} frameUrl URL of the mini app to fetch analytics for
+         * @param {FetchValidateFrameAnalyticsAnalyticsTypeEnum} analyticsType Type of analytics to fetch
          * @param {string} start
          * @param {string} stop
-         * @param {ValidateFrameAggregateWindow} [aggregateWindow] Required for &#x60;analytics_type&#x3D;interactions-per-cast&#x60;
+         * @param {FetchValidateFrameAnalyticsAggregateWindowEnum} [aggregateWindow] Required for &#x60;analytics_type&#x3D;interactions-per-cast&#x60;
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<FrameValidateAnalyticsResponse>} A promise that resolves to a `FrameValidateAnalyticsResponse` object
@@ -857,6 +906,26 @@ const FrameApiFp = function (configuration) {
             const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.fetchValidateFrameList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Retrieve notification delivery and opened stats for notification campaigns
+         * @summary Get notification campaign stats
+         * @param {string} [campaignId] An ID of a specific notification campaign to query
+         * @param {number} [limit] The number of results to return  (Default: 100, Maximum: 1000)
+         * @param {string} [cursor] Pagination cursor
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         * @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object
+         *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-notification-campaign-stats)
+         *
+         */
+        async getNotificationCampaignStats(campaignId, limit, cursor, options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getNotificationCampaignStats(campaignId, limit, cursor, options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.getNotificationCampaignStats']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Retrieves details about a transaction pay mini app by ID
          * @summary Get transaction pay mini app
@@ -865,6 +934,8 @@ const FrameApiFp = function (configuration) {
          * @throws {RequiredError}
          * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-transaction-pay-frame)
+         *
          */
         async getTransactionPayFrame(id, options) {
             var _a, _b, _c;
@@ -876,7 +947,7 @@ const FrameApiFp = function (configuration) {
         /**
          * Fetch a mini app either by UUID or Neynar URL
          * @summary Mini app by UUID or URL
-         * @param {FrameType} type
+         * @param {LookupNeynarFrameTypeEnum} type Type of identifier (either \&#39;uuid\&#39; or \&#39;url\&#39;)
          * @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.
@@ -894,7 +965,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 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.
+         * 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.
@@ -1004,7 +1075,7 @@ 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 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)
+         * 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.
@@ -1053,6 +1124,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-catalog)
+         *
          */
         fetchFrameCatalog(requestParameters = {}, options) {
             return localVarFp.fetchFrameCatalog(requestParameters.limit, requestParameters.cursor, requestParameters.timeWindow, requestParameters.categories, options).then((request) => request(axios, basePath));
@@ -1106,7 +1179,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
          * @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)
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-frames)
          *
          */
         fetchRelevantFrames(requestParameters, options) {
@@ -1139,6 +1212,20 @@ const FrameApiFactory = function (configuration, basePath, axios) {
         fetchValidateFrameList(options) {
             return localVarFp.fetchValidateFrameList(options).then((request) => request(axios, basePath));
         },
+        /**
+         * Retrieve notification delivery and opened stats for notification campaigns
+         * @summary Get notification campaign stats
+         * @param {FrameApiGetNotificationCampaignStatsRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         * @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object
+         *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-notification-campaign-stats)
+         *
+         */
+        getNotificationCampaignStats(requestParameters = {}, options) {
+            return localVarFp.getNotificationCampaignStats(requestParameters.campaignId, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
+        },
         /**
          * Retrieves details about a transaction pay mini app by ID
          * @summary Get transaction pay mini app
@@ -1147,6 +1234,8 @@ const FrameApiFactory = function (configuration, basePath, axios) {
          * @throws {RequiredError}
          * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
          *
+         * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-transaction-pay-frame)
+         *
          */
         getTransactionPayFrame(requestParameters, options) {
             return localVarFp.getTransactionPayFrame(requestParameters.id, options).then((request) => request(axios, basePath));
@@ -1166,7 +1255,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.lookupNeynarFrame(requestParameters.type, requestParameters.uuid, requestParameters.url, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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.
+         * 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.
@@ -1250,7 +1339,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.updateNeynarFrame(requestParameters.neynarFrameUpdateReqBody, options).then((request) => request(axios, basePath));
         },
         /**
-         * 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)
+         * 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.
@@ -1297,6 +1386,8 @@ class FrameApi extends base_1.BaseAPI {
      * @memberof FrameApi
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
      *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-catalog)
+     *
      */
     fetchFrameCatalog(requestParameters = {}, options) {
         return (0, exports.FrameApiFp)(this.configuration).fetchFrameCatalog(requestParameters.limit, requestParameters.cursor, requestParameters.timeWindow, requestParameters.categories, options).then((request) => request(this.axios, this.basePath));
@@ -1354,7 +1445,7 @@ class FrameApi extends base_1.BaseAPI {
      * @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)
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-relevant-frames)
      *
      */
     fetchRelevantFrames(requestParameters, options) {
@@ -1389,6 +1480,21 @@ class FrameApi extends base_1.BaseAPI {
     fetchValidateFrameList(options) {
         return (0, exports.FrameApiFp)(this.configuration).fetchValidateFrameList(options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * Retrieve notification delivery and opened stats for notification campaigns
+     * @summary Get notification campaign stats
+     * @param {FrameApiGetNotificationCampaignStatsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FrameApi
+     * @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-notification-campaign-stats)
+     *
+     */
+    getNotificationCampaignStats(requestParameters = {}, options) {
+        return (0, exports.FrameApiFp)(this.configuration).getNotificationCampaignStats(requestParameters.campaignId, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
+    }
     /**
      * Retrieves details about a transaction pay mini app by ID
      * @summary Get transaction pay mini app
@@ -1398,6 +1504,8 @@ class FrameApi extends base_1.BaseAPI {
      * @memberof FrameApi
      * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
      *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/get-transaction-pay-frame)
+     *
      */
     getTransactionPayFrame(requestParameters, options) {
         return (0, exports.FrameApiFp)(this.configuration).getTransactionPayFrame(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
@@ -1418,7 +1526,7 @@ 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 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.
+     * 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.
@@ -1508,7 +1616,7 @@ 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 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)
+     * 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.
@@ -1524,6 +1632,16 @@ class FrameApi extends base_1.BaseAPI {
     }
 }
 exports.FrameApi = FrameApi;
+/**
+ * @export
+ */
+exports.FetchFrameCatalogTimeWindowEnum = {
+    _1h: '1h',
+    _6h: '6h',
+    _12h: '12h',
+    _24h: '24h',
+    _7d: '7d'
+};
 /**
  * @export
  */
@@ -1542,3 +1660,45 @@ exports.FetchFrameCatalogCategoriesEnum = {
     Entertainment: 'entertainment',
     ArtCreativity: 'art-creativity'
 };
+/**
+ * @export
+ */
+exports.FetchRelevantFramesTimeWindowEnum = {
+    _1h: '1h',
+    _6h: '6h',
+    _12h: '12h',
+    _24h: '24h',
+    _7d: '7d'
+};
+/**
+ * @export
+ */
+exports.FetchValidateFrameAnalyticsAnalyticsTypeEnum = {
+    TotalInteractors: 'total-interactors',
+    Interactors: 'interactors',
+    InteractionsPerCast: 'interactions-per-cast',
+    InputText: 'input-text'
+};
+/**
+ * @export
+ */
+exports.FetchValidateFrameAnalyticsAggregateWindowEnum = {
+    _10s: '10s',
+    _1m: '1m',
+    _2m: '2m',
+    _5m: '5m',
+    _10m: '10m',
+    _20m: '20m',
+    _30m: '30m',
+    _2h: '2h',
+    _12h: '12h',
+    _1d: '1d',
+    _7d: '7d'
+};
+/**
+ * @export
+ */
+exports.LookupNeynarFrameTypeEnum = {
+    Uuid: 'uuid',
+    Url: 'url'
+};

package/build/api/apis/login-api.d.ts

@@ -1,8 +1,8 @@
 /**
- * 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.
+ * Neynar API
+ * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.44.0
+ * The version of the OpenAPI document: 3.18.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/build/api/apis/login-api.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * 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.
+ * Neynar API
+ * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.44.0
+ * The version of the OpenAPI document: 3.18.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -40,7 +40,7 @@ const LoginApiAxiosParamCreator = function (configuration) {
          *
          */
         fetchNonce: async (options = {}) => {
-            const localVarPath = `/farcaster/login/nonce`;
+            const localVarPath = `/v2/farcaster/login/nonce/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;