@neynar/nodejs-sdk 3.137.1 → 3.169.0

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

@@ -2,7 +2,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -24,9 +24,9 @@ export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration
     /**
      * Fetch a list of suggested users to follow. Used to help users discover new users to follow
      * @summary Suggest Follows
-     * @param {number | null} fid FID of the user whose following you want to fetch.
+     * @param {number} fid FID of the user whose following you want to fetch.
      * @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 | null} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
+     * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
      * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -35,7 +35,7 @@ export declare const FollowsApiAxiosParamCreator: (configuration?: Configuration
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-follow-suggestions)
      *
      */
-    fetchFollowSuggestions: (fid: number | null, xNeynarExperimental?: boolean, viewerFid?: number | null, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    fetchFollowSuggestions: (fid: number, xNeynarExperimental?: boolean, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\".
      * @summary Relevant followers
@@ -110,9 +110,9 @@ export declare const FollowsApiFp: (configuration?: Configuration) => {
     /**
      * Fetch a list of suggested users to follow. Used to help users discover new users to follow
      * @summary Suggest Follows
-     * @param {number | null} fid FID of the user whose following you want to fetch.
+     * @param {number} fid FID of the user whose following you want to fetch.
      * @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 | null} [viewerFid] Providing this will return a list of users that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
+     * @param {number} [viewerFid] Providing this will return a list of users that respects this user\&#39;s mutes and blocks and includes &#x60;viewer_context&#x60;.
      * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -121,7 +121,7 @@ export declare const FollowsApiFp: (configuration?: Configuration) => {
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-follow-suggestions)
      *
      */
-    fetchFollowSuggestions(fid: number | null, xNeynarExperimental?: boolean, viewerFid?: number | null, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsersResponse>>;
+    fetchFollowSuggestions(fid: number, xNeynarExperimental?: boolean, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UsersResponse>>;
     /**
      * Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\".
      * @summary Relevant followers
@@ -340,7 +340,7 @@ export interface FollowsApiFetchFollowSuggestionsRequest {
      * @type {number}
      * @memberof FollowsApiFetchFollowSuggestions
      */
-    readonly fid: number | null;
+    readonly fid: number;
     /**
      * Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
      *
@@ -358,7 +358,7 @@ export interface FollowsApiFetchFollowSuggestionsRequest {
      * @type {number}
      * @memberof FollowsApiFetchFollowSuggestions
      */
-    readonly viewerFid?: number | null;
+    readonly viewerFid?: number;
     /**
      * Number of results to fetch (Default: 25, Maximum: 100)
      *

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

@@ -5,7 +5,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -32,9 +32,9 @@ const FollowsApiAxiosParamCreator = function (configuration) {
         /**
          * Fetch a list of suggested users to follow. Used to help users discover new users to follow
          * @summary Suggest Follows
-         * @param {number | null} fid FID of the user whose following you want to fetch.
+         * @param {number} fid FID of the user whose following you want to fetch.
          * @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 | null} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
+         * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
          * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -319,9 +319,9 @@ const FollowsApiFp = function (configuration) {
         /**
          * Fetch a list of suggested users to follow. Used to help users discover new users to follow
          * @summary Suggest Follows
-         * @param {number | null} fid FID of the user whose following you want to fetch.
+         * @param {number} fid FID of the user whose following you want to fetch.
          * @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 | null} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
+         * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`.
          * @param {number} [limit] Number of results to fetch  (Default: 25, Maximum: 100)
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}

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

@@ -2,7 +2,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -95,7 +95,7 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
      */
     getTransactionPayFrame: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Send notifications to interactors of a mini app
+     * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
      * @summary Send notifications
      * @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
      * @param {*} [options] Override http request option.
@@ -198,7 +198,7 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
      */
     getTransactionPayFrame(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionFrameResponse>>;
     /**
-     * Send notifications to interactors of a mini app
+     * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
      * @summary Send notifications
      * @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
      * @param {*} [options] Override http request option.
@@ -291,7 +291,7 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      */
     getTransactionPayFrame(requestParameters: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionFrameResponse>;
     /**
-     * Send notifications to interactors of a mini app
+     * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
      * @summary Send notifications
      * @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -387,7 +387,7 @@ export interface FrameApiInterface {
      */
     getTransactionPayFrame(requestParameters: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionFrameResponse>;
     /**
-     * Send notifications to interactors of a mini app
+     * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
      * @summary Send notifications
      * @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -715,7 +715,7 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      */
     getTransactionPayFrame(requestParameters: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionFrameResponse, any, {}>>;
     /**
-     * Send notifications to interactors of a mini app
+     * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
      * @summary Send notifications
      * @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -5,7 +5,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -249,7 +249,7 @@ const FrameApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Send notifications to interactors of a mini app
+         * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
          * @summary Send notifications
          * @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
          * @param {*} [options] Override http request option.
@@ -444,7 +444,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 mini app
+         * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
          * @summary Send notifications
          * @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
          * @param {*} [options] Override http request option.
@@ -563,7 +563,7 @@ const FrameApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getTransactionPayFrame(requestParameters.id, options).then((request) => request(axios, basePath));
         },
         /**
-         * Send notifications to interactors of a mini app
+         * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
          * @summary Send notifications
          * @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
          * @param {*} [options] Override http request option.
@@ -676,7 +676,7 @@ class FrameApi extends base_1.BaseAPI {
         return (0, exports.FrameApiFp)(this.configuration).getTransactionPayFrame(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Send notifications to interactors of a mini app
+     * Send notifications to interactors of a mini app. By default every broadcast is delivered synchronously and returns 200 with aggregate counts. When the `ASYNC_NOTIFICATIONS_ENABLED` server flag is on, broadcasts with more than 100 notification tokens are queued and return 202 with a campaign_id instead; poll the campaign stats endpoint for progress. Small broadcasts always stay synchronous.
      * @summary Send notifications
      * @param {FrameApiPublishFrameNotificationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -2,7 +2,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.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

@@ -5,7 +5,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -5,7 +5,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -5,7 +5,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -2,7 +2,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -5,7 +5,7 @@
  * 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: 3.137.0
+ * The version of the OpenAPI document: 3.169.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).