@neynar/nodejs-sdk 2.44.0 → 2.46.0

package/build/clients/NeynarAPIClient.js

@@ -32,6 +32,7 @@ const constants_1 = require("../common/constants");
 const utils_1 = require("../utils");
 const action_api_1 = require("../api/apis/action-api");
 const agents_api_1 = require("../api/apis/agents-api");
+const app_host_api_1 = require("../api/apis/app-host-api");
 const ban_api_1 = require("../api/apis/ban-api");
 const block_api_1 = require("../api/apis/block-api");
 const cast_api_1 = require("../api/apis/cast-api");
@@ -140,6 +141,7 @@ const client = new NeynarAPIClient(config);\n`);
         this.apis = {
             actionApi: new action_api_1.ActionApi(this.config, undefined, axiosInstance),
             agentsApi: new agents_api_1.AgentsApi(this.config, undefined, axiosInstance),
+            appHostApi: new app_host_api_1.AppHostApi(this.config, undefined, axiosInstance),
             banApi: new ban_api_1.BanApi(this.config, undefined, axiosInstance),
             blockApi: new block_api_1.BlockApi(this.config, undefined, axiosInstance),
             castApi: new cast_api_1.CastApi(this.config, undefined, axiosInstance),
@@ -259,7 +261,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL.  Summary is generated by an LLM and is intended to be passed as a context to AI agents.
+     * Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Farcaster URL.  Summary is generated by an LLM and is intended to be passed as a context to AI agents.
      *
      * @summary Cast conversation summary
      *
@@ -290,6 +292,85 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.agentsApi.lookupCastConversationSummary(adjustedParams);
         return response.data;
     }
+    /**
+     * Returns event object for app host events. Used if the app host intends to sign the event message instead of using Neynar-hosted signers.
+     *
+     * @summary Get app host event
+     *
+     * @param {object} params
+     * @param {string} params.appDomain  - The domain of the mini app
+     * @param {number} params.fid  - The FID of the user who initiated the event
+     * @param {AppHostEventType} params.event  - The type of event
+     *
+     * @returns {Promise<AppHostGetEventResponse>} A promise that resolves to a `AppHostGetEventResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const appDomain =
+     * const fid =
+     * const event =
+     *
+     * client.appHostGetEvent({ appDomain, fid, event }).then(response => {
+     *   console.log('response:', response);
+     * });
+     */
+    async appHostGetEvent(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.appHostApi.appHostGetEvent(adjustedParams);
+        return response.data;
+    }
+    /**
+     * Returns the current notification state for a specific user across all mini app domains in this app host. Shows which domains have notifications enabled.
+     *
+     * @summary Get the user\'s notification subscriptions
+     *
+     * @param {object} params
+     * @param {number} params.fid  - The FID of the user
+     *
+     * @returns {Promise<AppHostUserStateResponse>} A promise that resolves to a `AppHostUserStateResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const fid =
+     *
+     * client.appHostGetUserState({ fid }).then(response => {
+     *   console.log('response:', response);
+     * });
+     */
+    async appHostGetUserState(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.appHostApi.appHostGetUserState(adjustedParams);
+        return response.data;
+    }
+    /**
+     * Post an app_host event to the domain\'s webhook. Events such as enabling or disabling notifications for a user. Provide either a signed message or the signer UUID of an authorized neynar-hosted signers.
+     *
+     * @summary Process app host event
+     *
+     * @param {object} params
+     * @param {AppHostPostEventBody} params.appHostPostEventBody
+     *
+     * @returns {Promise<AppHostPostEventResponse>} A promise that resolves to a `AppHostPostEventResponse` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const appHostPostEventBody =
+     *
+     * client.appHostPostEvent({ appHostPostEventBody }).then(response => {
+     *   console.log('response:', response);
+     * });
+     */
+    async appHostPostEvent(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.appHostApi.appHostPostEvent(adjustedParams);
+        return response.data;
+    }
     /**
      * Deletes a list of FIDs from the app associated with your API key.
      *
@@ -386,7 +467,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
-     * @param {number} params.blockedFid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.blockedFid  - The unique identifier of a farcaster user or app (unsigned integer)
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
@@ -452,7 +533,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
-     * @param {number} params.blockedFid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.blockedFid  - The unique identifier of a farcaster user or app (unsigned integer)
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
@@ -604,7 +685,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Gets information about an individual cast by passing in a Warpcast web URL or cast hash
+     * Gets information about an individual cast by passing in a Farcaster web URL or cast hash
      *
      * @summary By hash or URL
      *
@@ -638,7 +719,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Gets all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Includes all the ancestors of a cast up to the root parent in a chronological order. Includes all direct_replies to the cast up to the reply_depth specified in the query parameter.
+     * Gets all casts related to a conversation surrounding a cast by passing in a cast hash or Farcaster URL. Includes all the ancestors of a cast up to the root parent in a chronological order. Includes all direct_replies to the cast up to the reply_depth specified in the query parameter.
      *
      * @summary Conversation for a cast
      *
@@ -694,7 +775,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {string} params.parent [optional]  - parent_url of the channel the cast is in, or hash of the cast
      * @param {string} params.channelId [optional]  - Channel ID of the channel where the cast is to be posted. e.g. neynar, farcaster, warpcast
      * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
-     * @param {number} params.parentAuthorFid [optional]  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.parentAuthorFid [optional]  - The unique identifier of a farcaster user or app (unsigned integer)
      *
      * @returns {Promise<PostCastResponse>} A promise that resolves to a `PostCastResponse` object.
      *
@@ -1132,7 +1213,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
      * @param {string} params.channelId  - The unique identifier of a farcaster channel
-     * @param {number} params.fid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {ChannelMemberRole} params.role
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
@@ -1199,7 +1280,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
      * @param {string} params.channelId  - The unique identifier of a farcaster channel
-     * @param {number} params.fid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {ChannelMemberRole} params.role
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
@@ -2132,6 +2213,34 @@ const client = new NeynarAPIClient(config);\n`);
         const response = await this.apis.frameApi.fetchValidateFrameList();
         return response.data;
     }
+    /**
+     * Retrieve notification delivery and opened stats for notification campaigns
+     *
+     * @summary Get notification campaign stats
+     *
+     * @param {object} params
+     * @param {string} params.campaignId [optional]  - An ID of a specific notification campaign to query
+     * @param {number} params.limit [optional]  - The number of results to return (Default: 100,
+     * @param {string} params.cursor [optional]  - Pagination cursor
+     *
+     * @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object.
+     *
+     * @example
+     *
+     * // Fill in the appropriate values
+     * const campaignId =
+     * const limit =
+     *
+     * client.getNotificationCampaignStats({ campaignId, limit }).then(response => {
+     *   console.log('response:', response);
+     * });
+     */
+    async getNotificationCampaignStats(params) {
+        const adjustedParams = {};
+        Object.assign(adjustedParams, params);
+        const response = await this.apis.frameApi.getNotificationCampaignStats(adjustedParams);
+        return response.data;
+    }
     /**
      * Retrieves details about a transaction pay mini app by ID
      *
@@ -2448,7 +2557,7 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {string} params.q  - Query string to search for casts
-     * @param {FetchCastMetricsIntervalEnum} params.interval [optional]  - Interval of time for which to fetch metrics. Choices are `1d`, `7d`, `30d`
+     * @param {FetchCastMetricsIntervalEnum} params.interval [optional]  - Interval of time for which to fetch metrics. Default is 30d.
      * @param {number} params.authorFid [optional]  - Fid of the user whose casts you want to search
      * @param {string} params.channelId [optional]  - Channel ID of the casts you want to search
      *
@@ -2483,8 +2592,8 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Unmute FID
      *
      * @param {object} params
-     * @param {number} params.fid  - The unique identifier of a farcaster user (unsigned integer)
-     * @param {number} params.mutedFid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
+     * @param {number} params.mutedFid  - The unique identifier of a farcaster user or app (unsigned integer)
      *
      * @returns {Promise<MuteResponse>} A promise that resolves to a `MuteResponse` object.
      *
@@ -2547,8 +2656,8 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Mute FID
      *
      * @param {object} params
-     * @param {number} params.fid  - The unique identifier of a farcaster user (unsigned integer)
-     * @param {number} params.mutedFid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
+     * @param {number} params.mutedFid  - The unique identifier of a farcaster user or app (unsigned integer)
      *
      * @returns {Promise<MuteResponse>} A promise that resolves to a `MuteResponse` object.
      *
@@ -2717,7 +2826,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Creates a new token. This is an allowlisted API, reach out if you want access.
+     * Creates a new token.
      *
      * @summary Deploy fungible
      *
@@ -2904,7 +3013,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
      * @param {ReactionType} params.reactionType
      * @param {string} params.target  - Target cast hash (hex string starting with 0x) OR a valid URL.
-     * @param {number} params.targetAuthorFid [optional]  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.targetAuthorFid [optional]  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
@@ -3011,7 +3120,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
      * @param {ReactionType} params.reactionType
      * @param {string} params.target  - Target cast hash (hex string starting with 0x) OR a valid URL.
-     * @param {number} params.targetAuthorFid [optional]  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.targetAuthorFid [optional]  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
@@ -3212,7 +3321,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can't use a `uuid` made with a different API key.
      * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer’s public key
-     * @param {number} params.appFid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.appFid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {number} params.deadline  - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
      * @param {string} params.redirectUrl [optional]  - Url to redirect to after the signer is approved.  **Note** : This should only be used when requesting a signer from a native mobile application.
      * @param {SignedKeyRequestSponsor} params.sponsor [optional]
@@ -3251,7 +3360,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @param {string} params.publicKey  - Ed25519 public key
      * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer’s public key
-     * @param {number} params.appFid  - The unique identifier of a farcaster user (unsigned integer)
+     * @param {number} params.appFid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {number} params.deadline  - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
      * @param {string} params.redirectUrl [optional]  - Url to redirect to after the signer is approved.  **Note** : This should only be used when requesting a signer from a native mobile application.
      * @param {SignedKeyRequestSponsor} params.sponsor [optional]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neynar/nodejs-sdk",
-  "version": "2.44.0",
+  "version": "2.46.0",
   "description": "SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",