@neynar/nodejs-sdk 2.44.0 → 3.18.0

package/build/api/apis/frame-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).
@@ -21,10 +21,9 @@ import type { FrameActionReqBody } from '../models';
 import type { FrameCatalogResponse } from '../models';
 import type { FrameDeveloperManagedActionReqBody } from '../models';
 import type { FrameNotificationTokens } from '../models';
-import type { FrameType } from '../models';
 import type { FrameValidateAnalyticsResponse } from '../models';
 import type { FrameValidateListResponse } from '../models';
-import type { MiniAppTimeWindow } from '../models';
+import type { GetNotificationCampaignStats200Response } from '../models';
 import type { NeynarFrame } from '../models';
 import type { NeynarFrameCreationReqBody } from '../models';
 import type { NeynarFrameUpdateReqBody } from '../models';
@@ -33,8 +32,6 @@ import type { SendFrameNotificationsResponse } from '../models';
 import type { TransactionFrameResponse } from '../models';
 import type { ValidateFrameActionReqBody } from '../models';
 import type { ValidateFrameActionResponse } from '../models';
-import type { ValidateFrameAggregateWindow } from '../models';
-import type { ValidateFrameAnalyticsType } from '../models';
 /**
  * FrameApi - axios parameter creator
  * @export
@@ -57,14 +54,16 @@ export declare const FrameApiAxiosParamCreator: (configuration?: 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: (limit?: number, cursor?: string, timeWindow?: MiniAppTimeWindow, categories?: Array<FetchFrameCatalogCategoriesEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    fetchFrameCatalog: (limit?: number, cursor?: string, timeWindow?: FetchFrameCatalogTimeWindowEnum, categories?: Array<FetchFrameCatalogCategoriesEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Fetches the mini app meta tags from the URL
      * @summary Meta tags from URL
@@ -106,23 +105,23 @@ export declare const FrameApiAxiosParamCreator: (configuration?: 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: (viewerFid: number, timeWindow?: MiniAppTimeWindow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    fetchRelevantFrames: (viewerFid: number, timeWindow?: FetchRelevantFramesTimeWindowEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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
@@ -130,7 +129,7 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-validate-frame-analytics)
      *
      */
-    fetchValidateFrameAnalytics: (frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAggregateWindow, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    fetchValidateFrameAnalytics: (frameUrl: string, analyticsType: FetchValidateFrameAnalyticsAnalyticsTypeEnum, start: string, stop: string, aggregateWindow?: FetchValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Fetch a list of all the mini apps validated by a user
      * @summary All mini apps validated by user
@@ -142,6 +141,20 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
      *
      */
     fetchValidateFrameList: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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: (campaignId?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Retrieves details about a transaction pay mini app by ID
      * @summary Get transaction pay mini app
@@ -150,12 +163,14 @@ export declare const FrameApiAxiosParamCreator: (configuration?: 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: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
@@ -165,9 +180,9 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-neynar-frame)
      *
      */
-    lookupNeynarFrame: (type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    lookupNeynarFrame: (type: LookupNeynarFrameTypeEnum, uuid?: string, url?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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.
@@ -241,7 +256,7 @@ export declare const FrameApiAxiosParamCreator: (configuration?: Configuration)
      */
     updateNeynarFrame: (neynarFrameUpdateReqBody: NeynarFrameUpdateReqBody, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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.
@@ -275,14 +290,16 @@ export declare const FrameApiFp: (configuration?: 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(limit?: number, cursor?: string, timeWindow?: MiniAppTimeWindow, categories?: Array<FetchFrameCatalogCategoriesEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameCatalogResponse>>;
+    fetchFrameCatalog(limit?: number, cursor?: string, timeWindow?: FetchFrameCatalogTimeWindowEnum, categories?: Array<FetchFrameCatalogCategoriesEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameCatalogResponse>>;
     /**
      * Fetches the mini app meta tags from the URL
      * @summary Meta tags from URL
@@ -324,23 +341,23 @@ export declare const FrameApiFp: (configuration?: 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(viewerFid: number, timeWindow?: MiniAppTimeWindow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchRelevantFrames200Response>>;
+    fetchRelevantFrames(viewerFid: number, timeWindow?: FetchRelevantFramesTimeWindowEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FetchRelevantFrames200Response>>;
     /**
      * 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
@@ -348,7 +365,7 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-validate-frame-analytics)
      *
      */
-    fetchValidateFrameAnalytics(frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAggregateWindow, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameValidateAnalyticsResponse>>;
+    fetchValidateFrameAnalytics(frameUrl: string, analyticsType: FetchValidateFrameAnalyticsAnalyticsTypeEnum, start: string, stop: string, aggregateWindow?: FetchValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameValidateAnalyticsResponse>>;
     /**
      * Fetch a list of all the mini apps validated by a user
      * @summary All mini apps validated by user
@@ -360,6 +377,20 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
      *
      */
     fetchValidateFrameList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FrameValidateListResponse>>;
+    /**
+     * 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(campaignId?: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNotificationCampaignStats200Response>>;
     /**
      * Retrieves details about a transaction pay mini app by ID
      * @summary Get transaction pay mini app
@@ -368,12 +399,14 @@ export declare const FrameApiFp: (configuration?: 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(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionFrameResponse>>;
     /**
      * 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.
@@ -383,9 +416,9 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
      * For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-neynar-frame)
      *
      */
-    lookupNeynarFrame(type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NeynarFrame>>;
+    lookupNeynarFrame(type: LookupNeynarFrameTypeEnum, uuid?: string, url?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NeynarFrame>>;
     /**
-     * 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.
@@ -459,7 +492,7 @@ export declare const FrameApiFp: (configuration?: Configuration) => {
      */
     updateNeynarFrame(neynarFrameUpdateReqBody: NeynarFrameUpdateReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NeynarFrame>>;
     /**
-     * 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.
@@ -496,6 +529,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      * @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?: FrameApiFetchFrameCatalogRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameCatalogResponse>;
     /**
@@ -541,7 +576,7 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      * @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: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchRelevantFrames200Response>;
@@ -568,6 +603,18 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      *
      */
     fetchValidateFrameList(options?: RawAxiosRequestConfig): AxiosPromise<FrameValidateListResponse>;
+    /**
+     * 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?: FrameApiGetNotificationCampaignStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetNotificationCampaignStats200Response>;
     /**
      * Retrieves details about a transaction pay mini app by ID
      * @summary Get transaction pay mini app
@@ -576,6 +623,8 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      * @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: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionFrameResponse>;
     /**
@@ -591,7 +640,7 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      */
     lookupNeynarFrame(requestParameters: FrameApiLookupNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
     /**
-     * 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.
@@ -663,7 +712,7 @@ export declare const FrameApiFactory: (configuration?: Configuration, basePath?:
      */
     updateNeynarFrame(requestParameters: FrameApiUpdateNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
     /**
-     * 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.
@@ -703,6 +752,8 @@ export interface FrameApiInterface {
      * @memberof FrameApiInterface
      * @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?: FrameApiFetchFrameCatalogRequest, options?: RawAxiosRequestConfig): AxiosPromise<FrameCatalogResponse>;
     /**
@@ -752,7 +803,7 @@ export interface FrameApiInterface {
      * @memberof FrameApiInterface
      * @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: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): AxiosPromise<FetchRelevantFrames200Response>;
@@ -781,6 +832,19 @@ export interface FrameApiInterface {
      *
      */
     fetchValidateFrameList(options?: RawAxiosRequestConfig): AxiosPromise<FrameValidateListResponse>;
+    /**
+     * 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 FrameApiInterface
+     * @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?: FrameApiGetNotificationCampaignStatsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetNotificationCampaignStats200Response>;
     /**
      * Retrieves details about a transaction pay mini app by ID
      * @summary Get transaction pay mini app
@@ -790,6 +854,8 @@ export interface FrameApiInterface {
      * @memberof FrameApiInterface
      * @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: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionFrameResponse>;
     /**
@@ -806,7 +872,7 @@ export interface FrameApiInterface {
      */
     lookupNeynarFrame(requestParameters: FrameApiLookupNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
     /**
-     * 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.
@@ -884,7 +950,7 @@ export interface FrameApiInterface {
      */
     updateNeynarFrame(requestParameters: FrameApiUpdateNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise<NeynarFrame>;
     /**
-     * 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.
@@ -942,12 +1008,12 @@ export interface FrameApiFetchFrameCatalogRequest {
      *
      *
      *
-     * @type {MiniAppTimeWindow}
+     * @type {'1h' | '6h' | '12h' | '24h' | '7d'}
      * @memberof FrameApiFetchFrameCatalog
      */
-    readonly timeWindow?: MiniAppTimeWindow;
+    readonly timeWindow?: FetchFrameCatalogTimeWindowEnum;
     /**
-     * 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;
+     * 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
      *
      *
      *
@@ -1026,10 +1092,10 @@ export interface FrameApiFetchRelevantFramesRequest {
      *
      *
      *
-     * @type {MiniAppTimeWindow}
+     * @type {'1h' | '6h' | '12h' | '24h' | '7d'}
      * @memberof FrameApiFetchRelevantFrames
      */
-    readonly timeWindow?: MiniAppTimeWindow;
+    readonly timeWindow?: FetchRelevantFramesTimeWindowEnum;
 }
 /**
  * Request parameters for fetchValidateFrameAnalytics operation in FrameApi.
@@ -1038,7 +1104,7 @@ export interface FrameApiFetchRelevantFramesRequest {
  */
 export interface FrameApiFetchValidateFrameAnalyticsRequest {
     /**
-     *
+     * URL of the mini app to fetch analytics for
      *
      *
      *
@@ -1047,14 +1113,14 @@ export interface FrameApiFetchValidateFrameAnalyticsRequest {
      */
     readonly frameUrl: string;
     /**
+     * Type of analytics to fetch
      *
      *
      *
-     *
-     * @type {ValidateFrameAnalyticsType}
+     * @type {'total-interactors' | 'interactors' | 'interactions-per-cast' | 'input-text'}
      * @memberof FrameApiFetchValidateFrameAnalytics
      */
-    readonly analyticsType: ValidateFrameAnalyticsType;
+    readonly analyticsType: FetchValidateFrameAnalyticsAnalyticsTypeEnum;
     /**
      *
      *
@@ -1078,10 +1144,44 @@ export interface FrameApiFetchValidateFrameAnalyticsRequest {
      *
      *
      *
-     * @type {ValidateFrameAggregateWindow}
+     * @type {'10s' | '1m' | '2m' | '5m' | '10m' | '20m' | '30m' | '2h' | '12h' | '1d' | '7d'}
      * @memberof FrameApiFetchValidateFrameAnalytics
      */
-    readonly aggregateWindow?: ValidateFrameAggregateWindow;
+    readonly aggregateWindow?: FetchValidateFrameAnalyticsAggregateWindowEnum;
+}
+/**
+ * Request parameters for getNotificationCampaignStats operation in FrameApi.
+ * @export
+ * @interface FrameApiGetNotificationCampaignStatsRequest
+ */
+export interface FrameApiGetNotificationCampaignStatsRequest {
+    /**
+     * An ID of a specific notification campaign to query
+     *
+     *
+     *
+     * @type {string}
+     * @memberof FrameApiGetNotificationCampaignStats
+     */
+    readonly campaignId?: string;
+    /**
+     * The number of results to return (Default: 100, Maximum: 1000)
+     *
+     *
+     *
+     * @type {number}
+     * @memberof FrameApiGetNotificationCampaignStats
+     */
+    readonly limit?: number;
+    /**
+     * Pagination cursor
+     *
+     *
+     *
+     * @type {string}
+     * @memberof FrameApiGetNotificationCampaignStats
+     */
+    readonly cursor?: string;
 }
 /**
  * Request parameters for getTransactionPayFrame operation in FrameApi.
@@ -1106,14 +1206,14 @@ export interface FrameApiGetTransactionPayFrameRequest {
  */
 export interface FrameApiLookupNeynarFrameRequest {
     /**
+     * Type of identifier (either \&#39;uuid\&#39; or \&#39;url\&#39;)
      *
      *
      *
-     *
-     * @type {FrameType}
+     * @type {'uuid' | 'url'}
      * @memberof FrameApiLookupNeynarFrame
      */
-    readonly type: FrameType;
+    readonly type: LookupNeynarFrameTypeEnum;
     /**
      * UUID of the mini app to fetch
      *
@@ -1292,6 +1392,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      * @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?: FrameApiFetchFrameCatalogRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FrameCatalogResponse, any>>;
     /**
@@ -1341,7 +1443,7 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      * @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: FrameApiFetchRelevantFramesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FetchRelevantFrames200Response, any>>;
@@ -1370,6 +1472,19 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      *
      */
     fetchValidateFrameList(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FrameValidateListResponse, any>>;
+    /**
+     * 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?: FrameApiGetNotificationCampaignStatsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetNotificationCampaignStats200Response, any>>;
     /**
      * Retrieves details about a transaction pay mini app by ID
      * @summary Get transaction pay mini app
@@ -1379,6 +1494,8 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      * @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: FrameApiGetTransactionPayFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransactionFrameResponse, any>>;
     /**
@@ -1395,7 +1512,7 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      */
     lookupNeynarFrame(requestParameters: FrameApiLookupNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NeynarFrame, any>>;
     /**
-     * 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.
@@ -1473,7 +1590,7 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      */
     updateNeynarFrame(requestParameters: FrameApiUpdateNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NeynarFrame, any>>;
     /**
-     * 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.
@@ -1486,6 +1603,17 @@ export declare class FrameApi extends BaseAPI implements FrameApiInterface {
      */
     validateFrameAction(requestParameters: FrameApiValidateFrameActionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ValidateFrameActionResponse, any>>;
 }
+/**
+ * @export
+ */
+export declare const FetchFrameCatalogTimeWindowEnum: {
+    readonly _1h: "1h";
+    readonly _6h: "6h";
+    readonly _12h: "12h";
+    readonly _24h: "24h";
+    readonly _7d: "7d";
+};
+export type FetchFrameCatalogTimeWindowEnum = typeof FetchFrameCatalogTimeWindowEnum[keyof typeof FetchFrameCatalogTimeWindowEnum];
 /**
  * @export
  */
@@ -1505,3 +1633,49 @@ export declare const FetchFrameCatalogCategoriesEnum: {
     readonly ArtCreativity: "art-creativity";
 };
 export type FetchFrameCatalogCategoriesEnum = typeof FetchFrameCatalogCategoriesEnum[keyof typeof FetchFrameCatalogCategoriesEnum];
+/**
+ * @export
+ */
+export declare const FetchRelevantFramesTimeWindowEnum: {
+    readonly _1h: "1h";
+    readonly _6h: "6h";
+    readonly _12h: "12h";
+    readonly _24h: "24h";
+    readonly _7d: "7d";
+};
+export type FetchRelevantFramesTimeWindowEnum = typeof FetchRelevantFramesTimeWindowEnum[keyof typeof FetchRelevantFramesTimeWindowEnum];
+/**
+ * @export
+ */
+export declare const FetchValidateFrameAnalyticsAnalyticsTypeEnum: {
+    readonly TotalInteractors: "total-interactors";
+    readonly Interactors: "interactors";
+    readonly InteractionsPerCast: "interactions-per-cast";
+    readonly InputText: "input-text";
+};
+export type FetchValidateFrameAnalyticsAnalyticsTypeEnum = typeof FetchValidateFrameAnalyticsAnalyticsTypeEnum[keyof typeof FetchValidateFrameAnalyticsAnalyticsTypeEnum];
+/**
+ * @export
+ */
+export declare const FetchValidateFrameAnalyticsAggregateWindowEnum: {
+    readonly _10s: "10s";
+    readonly _1m: "1m";
+    readonly _2m: "2m";
+    readonly _5m: "5m";
+    readonly _10m: "10m";
+    readonly _20m: "20m";
+    readonly _30m: "30m";
+    readonly _2h: "2h";
+    readonly _12h: "12h";
+    readonly _1d: "1d";
+    readonly _7d: "7d";
+};
+export type FetchValidateFrameAnalyticsAggregateWindowEnum = typeof FetchValidateFrameAnalyticsAggregateWindowEnum[keyof typeof FetchValidateFrameAnalyticsAggregateWindowEnum];
+/**
+ * @export
+ */
+export declare const LookupNeynarFrameTypeEnum: {
+    readonly Uuid: "uuid";
+    readonly Url: "url";
+};
+export type LookupNeynarFrameTypeEnum = typeof LookupNeynarFrameTypeEnum[keyof typeof LookupNeynarFrameTypeEnum];