@neynar/nodejs-sdk 2.46.0 → 3.18.0

package/build/api/apis/notifications-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.46.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.NotificationsApi = exports.NotificationsApiFactory = exports.NotificationsApiFp = exports.NotificationsApiAxiosParamCreator = void 0;
+exports.FetchAllNotificationsTypeEnum = exports.NotificationsApi = exports.NotificationsApiFactory = exports.NotificationsApiFp = exports.NotificationsApiAxiosParamCreator = void 0;
 const axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -33,8 +33,8 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
          * Returns a list of notifications for a specific FID.
          * @summary For user
          * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks.
-         * @param {Array<NotificationType>} [type] Notification type to fetch. Comma separated values of follows, recasts, likes, mentions, replies.
-         * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the user follows.
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
+         * @param {Array<FetchAllNotificationsTypeEnum>} [type] Notification type to fetch. Comma separated values of follows, recasts, likes, mentions, replies.
          * @param {number} [limit] Number of results to fetch  (Default: 15, Maximum: 25)
          * @param {string} [cursor] Pagination cursor.
          * @param {*} [options] Override http request option.
@@ -44,10 +44,10 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-all-notifications)
          *
          */
-        fetchAllNotifications: async (fid, type, priorityMode, limit, cursor, options = {}) => {
+        fetchAllNotifications: async (fid, xNeynarExperimental, type, limit, cursor, options = {}) => {
             // verify required parameter 'fid' is not null or undefined
             (0, common_1.assertParamExists)('fetchAllNotifications', 'fid', fid);
-            const localVarPath = `/farcaster/notifications`;
+            const localVarPath = `/v2/farcaster/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;
@@ -63,10 +63,7 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
                 localVarQueryParameter['fid'] = fid;
             }
             if (type) {
-                localVarQueryParameter['type'] = type.join(base_1.COLLECTION_FORMATS.csv);
-            }
-            if (priorityMode !== undefined) {
-                localVarQueryParameter['priority_mode'] = priorityMode;
+                localVarQueryParameter['type'] = type;
             }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
@@ -74,6 +71,11 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
             if (cursor !== undefined) {
                 localVarQueryParameter['cursor'] = cursor;
             }
+            if (xNeynarExperimental != null) {
+                localVarHeaderParameter['x-neynar-experimental'] = typeof xNeynarExperimental === 'string'
+                    ? xNeynarExperimental
+                    : JSON.stringify(xNeynarExperimental);
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -87,7 +89,7 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
          * @summary For user by channel
          * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\&#39;s mutes and blocks.
          * @param {string} channelIds Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels)
-         * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the user follows.
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {number} [limit] Number of results to fetch  (Default: 15, Maximum: 25)
          * @param {string} [cursor] Pagination cursor.
          * @param {*} [options] Override http request option.
@@ -97,12 +99,12 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-channel-notifications-for-user)
          *
          */
-        fetchChannelNotificationsForUser: async (fid, channelIds, priorityMode, limit, cursor, options = {}) => {
+        fetchChannelNotificationsForUser: async (fid, channelIds, xNeynarExperimental, limit, cursor, options = {}) => {
             // verify required parameter 'fid' is not null or undefined
             (0, common_1.assertParamExists)('fetchChannelNotificationsForUser', 'fid', fid);
             // verify required parameter 'channelIds' is not null or undefined
             (0, common_1.assertParamExists)('fetchChannelNotificationsForUser', 'channelIds', channelIds);
-            const localVarPath = `/farcaster/notifications/channel`;
+            const localVarPath = `/v2/farcaster/notifications/channel/`;
             // 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;
@@ -120,15 +122,17 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
             if (channelIds !== undefined) {
                 localVarQueryParameter['channel_ids'] = channelIds;
             }
-            if (priorityMode !== undefined) {
-                localVarQueryParameter['priority_mode'] = priorityMode;
-            }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
             }
             if (cursor !== undefined) {
                 localVarQueryParameter['cursor'] = cursor;
             }
+            if (xNeynarExperimental != null) {
+                localVarHeaderParameter['x-neynar-experimental'] = typeof xNeynarExperimental === 'string'
+                    ? xNeynarExperimental
+                    : JSON.stringify(xNeynarExperimental);
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -142,7 +146,7 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
          * @summary For user by parent_urls
          * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\&#39;s mutes and blocks.
          * @param {string} parentUrls Comma separated parent_urls
-         * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the user follows.
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {number} [limit] Number of results to fetch  (Default: 15, Maximum: 25)
          * @param {string} [cursor] Pagination cursor.
          * @param {*} [options] Override http request option.
@@ -152,12 +156,12 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-notifications-by-parent-url-for-user)
          *
          */
-        fetchNotificationsByParentUrlForUser: async (fid, parentUrls, priorityMode, limit, cursor, options = {}) => {
+        fetchNotificationsByParentUrlForUser: async (fid, parentUrls, xNeynarExperimental, limit, cursor, options = {}) => {
             // verify required parameter 'fid' is not null or undefined
             (0, common_1.assertParamExists)('fetchNotificationsByParentUrlForUser', 'fid', fid);
             // verify required parameter 'parentUrls' is not null or undefined
             (0, common_1.assertParamExists)('fetchNotificationsByParentUrlForUser', 'parentUrls', parentUrls);
-            const localVarPath = `/farcaster/notifications/parent_url`;
+            const localVarPath = `/v2/farcaster/notifications/parent_url/`;
             // 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;
@@ -175,15 +179,17 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
             if (parentUrls !== undefined) {
                 localVarQueryParameter['parent_urls'] = parentUrls;
             }
-            if (priorityMode !== undefined) {
-                localVarQueryParameter['priority_mode'] = priorityMode;
-            }
             if (limit !== undefined) {
                 localVarQueryParameter['limit'] = limit;
             }
             if (cursor !== undefined) {
                 localVarQueryParameter['cursor'] = cursor;
             }
+            if (xNeynarExperimental != null) {
+                localVarHeaderParameter['x-neynar-experimental'] = typeof xNeynarExperimental === 'string'
+                    ? xNeynarExperimental
+                    : JSON.stringify(xNeynarExperimental);
+            }
             (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -207,7 +213,7 @@ const NotificationsApiAxiosParamCreator = function (configuration) {
         markNotificationsAsSeen: async (markNotificationsAsSeenReqBody, authorization, options = {}) => {
             // verify required parameter 'markNotificationsAsSeenReqBody' is not null or undefined
             (0, common_1.assertParamExists)('markNotificationsAsSeen', 'markNotificationsAsSeenReqBody', markNotificationsAsSeenReqBody);
-            const localVarPath = `/farcaster/notifications/seen`;
+            const localVarPath = `/v2/farcaster/notifications/seen/`;
             // 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;
@@ -246,8 +252,8 @@ const NotificationsApiFp = function (configuration) {
          * Returns a list of notifications for a specific FID.
          * @summary For user
          * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\&#39;s mutes and blocks.
-         * @param {Array<NotificationType>} [type] Notification type to fetch. Comma separated values of follows, recasts, likes, mentions, replies.
-         * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the user follows.
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
+         * @param {Array<FetchAllNotificationsTypeEnum>} [type] Notification type to fetch. Comma separated values of follows, recasts, likes, mentions, replies.
          * @param {number} [limit] Number of results to fetch  (Default: 15, Maximum: 25)
          * @param {string} [cursor] Pagination cursor.
          * @param {*} [options] Override http request option.
@@ -257,9 +263,9 @@ const NotificationsApiFp = function (configuration) {
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-all-notifications)
          *
          */
-        async fetchAllNotifications(fid, type, priorityMode, limit, cursor, options) {
+        async fetchAllNotifications(fid, xNeynarExperimental, type, limit, cursor, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchAllNotifications(fid, type, priorityMode, limit, cursor, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchAllNotifications(fid, xNeynarExperimental, type, 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['NotificationsApi.fetchAllNotifications']) === 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);
@@ -269,7 +275,7 @@ const NotificationsApiFp = function (configuration) {
          * @summary For user by channel
          * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\&#39;s mutes and blocks.
          * @param {string} channelIds Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels)
-         * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the user follows.
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {number} [limit] Number of results to fetch  (Default: 15, Maximum: 25)
          * @param {string} [cursor] Pagination cursor.
          * @param {*} [options] Override http request option.
@@ -279,9 +285,9 @@ const NotificationsApiFp = function (configuration) {
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-channel-notifications-for-user)
          *
          */
-        async fetchChannelNotificationsForUser(fid, channelIds, priorityMode, limit, cursor, options) {
+        async fetchChannelNotificationsForUser(fid, channelIds, xNeynarExperimental, limit, cursor, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchChannelNotificationsForUser(fid, channelIds, priorityMode, limit, cursor, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchChannelNotificationsForUser(fid, channelIds, xNeynarExperimental, 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['NotificationsApi.fetchChannelNotificationsForUser']) === 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);
@@ -291,7 +297,7 @@ const NotificationsApiFp = function (configuration) {
          * @summary For user by parent_urls
          * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\&#39;s mutes and blocks.
          * @param {string} parentUrls Comma separated parent_urls
-         * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the user follows.
+         * @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
          * @param {number} [limit] Number of results to fetch  (Default: 15, Maximum: 25)
          * @param {string} [cursor] Pagination cursor.
          * @param {*} [options] Override http request option.
@@ -301,9 +307,9 @@ const NotificationsApiFp = function (configuration) {
          * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-notifications-by-parent-url-for-user)
          *
          */
-        async fetchNotificationsByParentUrlForUser(fid, parentUrls, priorityMode, limit, cursor, options) {
+        async fetchNotificationsByParentUrlForUser(fid, parentUrls, xNeynarExperimental, limit, cursor, options) {
             var _a, _b, _c;
-            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchNotificationsByParentUrlForUser(fid, parentUrls, priorityMode, limit, cursor, options);
+            const localVarAxiosArgs = await localVarAxiosParamCreator.fetchNotificationsByParentUrlForUser(fid, parentUrls, xNeynarExperimental, 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['NotificationsApi.fetchNotificationsByParentUrlForUser']) === 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);
@@ -349,7 +355,7 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
          *
          */
         fetchAllNotifications(requestParameters, options) {
-            return localVarFp.fetchAllNotifications(requestParameters.fid, requestParameters.type, requestParameters.priorityMode, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
+            return localVarFp.fetchAllNotifications(requestParameters.fid, requestParameters.xNeynarExperimental, requestParameters.type, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of notifications for a user in specific channels
@@ -363,7 +369,7 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
          *
          */
         fetchChannelNotificationsForUser(requestParameters, options) {
-            return localVarFp.fetchChannelNotificationsForUser(requestParameters.fid, requestParameters.channelIds, requestParameters.priorityMode, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
+            return localVarFp.fetchChannelNotificationsForUser(requestParameters.fid, requestParameters.channelIds, requestParameters.xNeynarExperimental, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
         },
         /**
          * Returns a list of notifications for a user in specific parent_urls
@@ -377,7 +383,7 @@ const NotificationsApiFactory = function (configuration, basePath, axios) {
          *
          */
         fetchNotificationsByParentUrlForUser(requestParameters, options) {
-            return localVarFp.fetchNotificationsByParentUrlForUser(requestParameters.fid, requestParameters.parentUrls, requestParameters.priorityMode, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
+            return localVarFp.fetchNotificationsByParentUrlForUser(requestParameters.fid, requestParameters.parentUrls, requestParameters.xNeynarExperimental, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
         },
         /**
          * Mark notifications as seen. You can choose one of two authorization methods, either:   1. Provide a valid signer_uuid in the request body (Most common)   2. Provide a valid, signed \"Bearer\" token in the request\'s `Authorization` header similar to the      approach described [here](https://docs.farcaster.xyz/reference/warpcast/api#authentication)
@@ -416,7 +422,7 @@ class NotificationsApi extends base_1.BaseAPI {
      *
      */
     fetchAllNotifications(requestParameters, options) {
-        return (0, exports.NotificationsApiFp)(this.configuration).fetchAllNotifications(requestParameters.fid, requestParameters.type, requestParameters.priorityMode, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.NotificationsApiFp)(this.configuration).fetchAllNotifications(requestParameters.fid, requestParameters.xNeynarExperimental, requestParameters.type, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Returns a list of notifications for a user in specific channels
@@ -431,7 +437,7 @@ class NotificationsApi extends base_1.BaseAPI {
      *
      */
     fetchChannelNotificationsForUser(requestParameters, options) {
-        return (0, exports.NotificationsApiFp)(this.configuration).fetchChannelNotificationsForUser(requestParameters.fid, requestParameters.channelIds, requestParameters.priorityMode, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.NotificationsApiFp)(this.configuration).fetchChannelNotificationsForUser(requestParameters.fid, requestParameters.channelIds, requestParameters.xNeynarExperimental, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Returns a list of notifications for a user in specific parent_urls
@@ -446,7 +452,7 @@ class NotificationsApi extends base_1.BaseAPI {
      *
      */
     fetchNotificationsByParentUrlForUser(requestParameters, options) {
-        return (0, exports.NotificationsApiFp)(this.configuration).fetchNotificationsByParentUrlForUser(requestParameters.fid, requestParameters.parentUrls, requestParameters.priorityMode, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
+        return (0, exports.NotificationsApiFp)(this.configuration).fetchNotificationsByParentUrlForUser(requestParameters.fid, requestParameters.parentUrls, requestParameters.xNeynarExperimental, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
     }
     /**
      * Mark notifications as seen. You can choose one of two authorization methods, either:   1. Provide a valid signer_uuid in the request body (Most common)   2. Provide a valid, signed \"Bearer\" token in the request\'s `Authorization` header similar to the      approach described [here](https://docs.farcaster.xyz/reference/warpcast/api#authentication)
@@ -465,3 +471,14 @@ class NotificationsApi extends base_1.BaseAPI {
     }
 }
 exports.NotificationsApi = NotificationsApi;
+/**
+ * @export
+ */
+exports.FetchAllNotificationsTypeEnum = {
+    Follows: 'follows',
+    Recasts: 'recasts',
+    Likes: 'likes',
+    Mentions: 'mentions',
+    Replies: 'replies',
+    Quotes: 'quotes'
+};