@neynar/nodejs-sdk 2.31.0 → 2.33.0

package/build/clients/NeynarAPIClient.js

@@ -201,9 +201,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Creates a new transaction pay frame that can be used to collect payments through a frame
+     * Creates a new transaction pay mini app that can be used to collect payments through a mini app
      *
-     * @summary Create transaction pay frame
+     * @summary Create transaction pay mini app
      *
      * @param {object} params
      * @param {FramePayTransactionRequestBody} params.framePayTransactionRequestBody
@@ -1555,9 +1555,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch feed of casts with Frames, reverse chronological order
+     * Fetch feed of casts with mini apps, reverse chronological order
      *
-     * @summary Casts with Frames
+     * @summary Casts with mini apps
      *
      * @param {object} params
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 25, Maximum: 100)
@@ -1901,9 +1901,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Delete an existing frame, if it was made by the developer (identified by API key)
+     * Delete an existing mini app, if it was made by the developer (identified by API key)
      *
-     * @summary Delete frame
+     * @summary Delete mini app
      *
      * @param {object} params
      * @param {string} params.uuid [optional]
@@ -1930,14 +1930,14 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * A curated list of featured frames
+     * A curated list of featured mini apps
      *
-     * @summary Frames Catalog
+     * @summary Mini apps catalog
      *
      * @param {object} params
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 100, Maximum: 100)
      * @param {string} params.cursor [optional]  - Pagination cursor
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to calculate the change in trending score for each frame, used to sort frame results
+     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to calculate the change in trending score for each mini app, used to sort mini app results
      *
      * @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object.
      *
@@ -1958,12 +1958,12 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetches the frame meta tags from the URL
+     * Fetches the mini app meta tags from the URL
      *
      * @summary Meta tags from URL
      *
      * @param {object} params
-     * @param {string} params.url  - The frame URL to crawl
+     * @param {string} params.url  - The mini app URL to crawl
      *
      * @returns {Promise<FetchFrameMetaTagsFromUrl200Response>} A promise that resolves to a `FetchFrameMetaTagsFromUrl200Response` object.
      *
@@ -1986,9 +1986,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch a list of frames made by the developer (identified by API key)
+     * Fetch a list of mini apps made by the developer (identified by API key)
      *
-     * @summary List of frames
+     * @summary List of mini apps
      *
      *
      * @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object.
@@ -2007,9 +2007,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Returns a list of notifications tokens related for an app
+     * Returns a list of notifications tokens related to a mini app
      *
-     * @summary List of frame notification tokens
+     * @summary List of mini app notification tokens
      *
      * @param {object} params
      * @param {number} params.limit [optional]  - Number of results to fetch (Default: 20, Maximum: 100)
@@ -2044,13 +2044,13 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch a list of frames relevant to the user based on casts by users with strong affinity score for the user
+     * Fetch a list of mini apps relevant to the user based on casts by users with strong affinity score for the user
      *
-     * @summary Relevant frames
+     * @summary Relevant mini apps
      *
      * @param {object} params
-     * @param {number} params.viewerFid  - FID of the user to fetch relevant frames for
-     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to limit statistics used to calculate frame relevance
+     * @param {number} params.viewerFid  - FID of the user to fetch relevant mini apps for
+     * @param {TrendingTimeWindow} params.timeWindow [optional]  - Time window used to limit statistics used to calculate mini app relevance
      *
      * @returns {Promise<FetchRelevantFrames200Response>} A promise that resolves to a `FetchRelevantFrames200Response` object.
      *
@@ -2063,6 +2063,9 @@ const client = new NeynarAPIClient(config);\n`);
      * client.fetchRelevantFrames({ viewerFid, timeWindow }).then(response => {
      *   console.log('response:', response);
      * });
+     *
+     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-relevant)
+     *
      */
     async fetchRelevantFrames(params) {
         const adjustedParams = {};
@@ -2073,7 +2076,7 @@ const client = new NeynarAPIClient(config);\n`);
     /**
      * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text.
      *
-     * @summary Analytics for the frame
+     * @summary Analytics for the mini app
      *
      * @param {object} params
      * @param {string} params.frameUrl
@@ -2107,9 +2110,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch a list of all the frames validated by a user
+     * Fetch a list of all the mini apps validated by a user
      *
-     * @summary All frames validated by user
+     * @summary All mini apps validated by user
      *
      *
      * @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object.
@@ -2128,12 +2131,12 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Retrieves details about a transaction pay frame by ID
+     * Retrieves details about a transaction pay mini app by ID
      *
-     * @summary Get transaction pay frame
+     * @summary Get transaction pay mini app
      *
      * @param {object} params
-     * @param {string} params.id  - ID of the transaction frame to retrieve
+     * @param {string} params.id  - ID of the transaction mini app to retrieve
      *
      * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object.
      *
@@ -2153,14 +2156,14 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Fetch a frame either by UUID or Neynar URL
+     * Fetch a mini app either by UUID or Neynar URL
      *
-     * @summary Frame by UUID or URL
+     * @summary Mini app by UUID or URL
      *
      * @param {object} params
      * @param {FrameType} params.type
-     * @param {string} params.uuid [optional]  - UUID of the frame to fetch
-     * @param {string} params.url [optional]  - URL of the Neynar frame to fetch
+     * @param {string} params.uuid [optional]  - UUID of the mini app to fetch
+     * @param {string} params.url [optional]  - URL of the Neynar mini app to fetch
      *
      * @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object.
      *
@@ -2185,9 +2188,9 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Post frame actions, cast actions or cast composer actions to the server  \\ (In order to post any of these actions, you need to have an approved `signer_uuid`)  The POST request to the post_url has a timeout of 5 seconds for frames.
+     * 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 frame action, cast action or a cast composer action
+     * @summary Post a mini app action, cast action or a cast composer action
      *
      * @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.
@@ -2218,7 +2221,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Post a frame action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
+     * Post a mini app action that has been signed with a developer managed signer  The POST request to the post_url has a timeout of 5 seconds.
      *
      * @summary Signature packet
      *
@@ -2251,7 +2254,7 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Send notifications to interactors of a frame
+     * Send notifications to interactors of a mini app
      *
      * @summary Send notifications
      *
@@ -2282,12 +2285,12 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Create a new frame with a list of pages.
+     * Create a new mini app with a list of pages.
      *
-     * @summary Create frame
+     * @summary Create mini app
      *
      * @param {object} params
-     * @param {string} params.name  - The name of the frame.
+     * @param {string} params.name  - The name of the mini app.
      * @param {Array<NeynarFramePage>} params.pages
      *
      * @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object.
@@ -2313,13 +2316,13 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Update an existing frame with a list of pages, if it was made by the developer (identified by API key)
+     * Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
      *
-     * @summary Update frame
+     * @summary Update mini app
      *
      * @param {object} params
-     * @param {string} params.uuid  - The UUID of the frame to update.
-     * @param {string} params.name [optional]  - The name of the frame.
+     * @param {string} params.uuid  - The UUID of the mini app to update.
+     * @param {string} params.name [optional]  - The name of the mini app.
      * @param {Array<NeynarFramePage>} params.pages
      *
      * @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object.
@@ -2346,13 +2349,13 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
-     * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex)
+     * 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 frame action
+     * @summary Validate mini app action
      *
      * @param {object} params
      * @param {string} params.messageBytesInHex  - Hexadecimal string of message bytes.
-     * @param {boolean} params.castReactionContext [optional]  - Adds viewer_context inside the cast object to indicate whether the interactor reacted to the cast housing the frame.
+     * @param {boolean} params.castReactionContext [optional]  - Adds viewer_context inside the cast object to indicate whether the interactor reacted to the cast housing the mini app.
      * @param {boolean} params.followContext [optional]  - Adds viewer_context inside the user (interactor) object to indicate whether the interactor follows or is followed by the cast author.
      * @param {boolean} params.signerContext [optional]  - Adds context about the app used by the user inside `frame.action`.
      * @param {boolean} params.channelFollowContext [optional]  - Adds context about the channel that the cast belongs to inside of the cast object.

package/package.json

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