@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
819 lines • 102 kB
JavaScript
"use strict";
/* tslint:disable */
/* eslint-disable */
/**
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.46.0
* Contact: team@neynar.com
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.FetchFrameCatalogCategoriesEnum = exports.FrameApi = exports.FrameApiFactory = exports.FrameApiFp = exports.FrameApiAxiosParamCreator = void 0;
const axios_1 = __importDefault(require("axios"));
// Some imports not used depending on template conditions
// @ts-ignore
const common_1 = require("../common");
// @ts-ignore
const base_1 = require("../base");
/**
* FrameApi - axios parameter creator
* @export
*/
const FrameApiAxiosParamCreator = function (configuration) {
return {
/**
* Delete an existing mini app, if it was made by the developer (identified by API key)
* @summary Delete mini app
* @param {DeleteFrameReqBody} deleteFrameReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeleteFrameResponse>} A promise that resolves to a `DeleteFrameResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-neynar-frame)
*
*/
deleteNeynarFrame: async (deleteFrameReqBody, options = {}) => {
// verify required parameter 'deleteFrameReqBody' is not null or undefined
(0, common_1.assertParamExists)('deleteNeynarFrame', 'deleteFrameReqBody', deleteFrameReqBody);
const localVarPath = `/farcaster/frame`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(deleteFrameReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* A curated list of featured mini apps
* @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: `categories=games,social` OR: `categories=games&categories=social`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
*
*/
fetchFrameCatalog: async (limit, cursor, timeWindow, categories, options = {}) => {
const localVarPath = `/farcaster/frame/catalog`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (cursor !== undefined) {
localVarQueryParameter['cursor'] = cursor;
}
if (timeWindow !== undefined) {
localVarQueryParameter['time_window'] = timeWindow;
}
if (categories) {
localVarQueryParameter['categories'] = categories.join(base_1.COLLECTION_FORMATS.csv);
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Fetches the mini app meta tags from the URL
* @summary Meta tags from URL
* @param {string} url The mini app URL to crawl
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchFrameMetaTagsFromUrl200Response>} A promise that resolves to a `FetchFrameMetaTagsFromUrl200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-meta-tags-from-url)
*
*/
fetchFrameMetaTagsFromUrl: async (url, options = {}) => {
// verify required parameter 'url' is not null or undefined
(0, common_1.assertParamExists)('fetchFrameMetaTagsFromUrl', 'url', url);
const localVarPath = `/farcaster/frame/crawl`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (url !== undefined) {
localVarQueryParameter['url'] = url;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Fetch a list of mini apps made by the developer (identified by API key)
* @summary List of mini apps
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-neynar-frames)
*
*/
fetchNeynarFrames: async (options = {}) => {
const localVarPath = `/farcaster/frame/list`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Returns a list of notifications tokens related to a mini app
* @summary List of mini app notification tokens
* @param {number} [limit] Number of results to fetch (Default: 20, Maximum: 100)
* @param {string} [fids] Comma separated list of FIDs, up to 100 at a time. If you pass in FIDs, you will get back the notification tokens for those FIDs. If you don\'t pass in FIDs, you will get back all the notification tokens for the mini app.
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FrameNotificationTokens>} A promise that resolves to a `FrameNotificationTokens` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-notification-tokens)
*
*/
fetchNotificationTokens: async (limit, fids, cursor, options = {}) => {
const localVarPath = `/farcaster/frame/notification_tokens`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (fids !== undefined) {
localVarQueryParameter['fids'] = fids;
}
if (cursor !== undefined) {
localVarQueryParameter['cursor'] = cursor;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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 {*} [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)
*
*/
fetchRelevantFrames: async (viewerFid, timeWindow, options = {}) => {
// verify required parameter 'viewerFid' is not null or undefined
(0, common_1.assertParamExists)('fetchRelevantFrames', 'viewerFid', viewerFid);
const localVarPath = `/farcaster/frame/relevant`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (viewerFid !== undefined) {
localVarQueryParameter['viewer_fid'] = viewerFid;
}
if (timeWindow !== undefined) {
localVarQueryParameter['time_window'] = timeWindow;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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} start
* @param {string} stop
* @param {ValidateFrameAggregateWindow} [aggregateWindow] Required for `analytics_type=interactions-per-cast`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FrameValidateAnalyticsResponse>} A promise that resolves to a `FrameValidateAnalyticsResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-validate-frame-analytics)
*
*/
fetchValidateFrameAnalytics: async (frameUrl, analyticsType, start, stop, aggregateWindow, options = {}) => {
// verify required parameter 'frameUrl' is not null or undefined
(0, common_1.assertParamExists)('fetchValidateFrameAnalytics', 'frameUrl', frameUrl);
// verify required parameter 'analyticsType' is not null or undefined
(0, common_1.assertParamExists)('fetchValidateFrameAnalytics', 'analyticsType', analyticsType);
// verify required parameter 'start' is not null or undefined
(0, common_1.assertParamExists)('fetchValidateFrameAnalytics', 'start', start);
// verify required parameter 'stop' is not null or undefined
(0, common_1.assertParamExists)('fetchValidateFrameAnalytics', 'stop', stop);
const localVarPath = `/farcaster/frame/validate/analytics`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (frameUrl !== undefined) {
localVarQueryParameter['frame_url'] = frameUrl;
}
if (analyticsType !== undefined) {
localVarQueryParameter['analytics_type'] = analyticsType;
}
if (start !== undefined) {
localVarQueryParameter['start'] = (start instanceof Date) ?
start.toISOString() :
start;
}
if (stop !== undefined) {
localVarQueryParameter['stop'] = (stop instanceof Date) ?
stop.toISOString() :
stop;
}
if (aggregateWindow !== undefined) {
localVarQueryParameter['aggregate_window'] = aggregateWindow;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Fetch a list of all the mini apps validated by a user
* @summary All mini apps validated by user
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FrameValidateListResponse>} A promise that resolves to a `FrameValidateListResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-validate-frame-list)
*
*/
fetchValidateFrameList: async (options = {}) => {
const localVarPath = `/farcaster/frame/validate/list`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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,
* @param {string} [cursor] Pagination cursor
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<GetNotificationCampaignStats200Response>} A promise that resolves to a `GetNotificationCampaignStats200Response` object
*
*/
getNotificationCampaignStats: async (campaignId, limit, cursor, options = {}) => {
const localVarPath = `/farcaster/frame/notifications`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (campaignId !== undefined) {
localVarQueryParameter['campaign_id'] = campaignId;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (cursor !== undefined) {
localVarQueryParameter['cursor'] = cursor;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Retrieves details about a transaction pay mini app by ID
* @summary Get transaction pay mini app
* @param {string} id ID of the transaction mini app to retrieve
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object
*
*/
getTransactionPayFrame: async (id, options = {}) => {
// verify required parameter 'id' is not null or undefined
(0, common_1.assertParamExists)('getTransactionPayFrame', 'id', id);
const localVarPath = `/farcaster/frame/transaction/pay`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (id !== undefined) {
localVarQueryParameter['id'] = id;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Fetch a mini app either by UUID or Neynar URL
* @summary Mini app by UUID or URL
* @param {FrameType} type
* @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.
* @throws {RequiredError}
* @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-neynar-frame)
*
*/
lookupNeynarFrame: async (type, uuid, url, options = {}) => {
// verify required parameter 'type' is not null or undefined
(0, common_1.assertParamExists)('lookupNeynarFrame', 'type', type);
const localVarPath = `/farcaster/frame`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (type !== undefined) {
localVarQueryParameter['type'] = type;
}
if (uuid !== undefined) {
localVarQueryParameter['uuid'] = uuid;
}
if (url !== undefined) {
localVarQueryParameter['url'] = url;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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.
* @throws {RequiredError}
* @returns {Promise<Frame>} A promise that resolves to a `Frame` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/post-frame-action)
*
*/
postFrameAction: async (frameActionReqBody, options = {}) => {
// verify required parameter 'frameActionReqBody' is not null or undefined
(0, common_1.assertParamExists)('postFrameAction', 'frameActionReqBody', frameActionReqBody);
const localVarPath = `/farcaster/frame/action`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(frameActionReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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
* @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Frame>} A promise that resolves to a `Frame` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/post-frame-action-developer-managed)
*
*/
postFrameActionDeveloperManaged: async (frameDeveloperManagedActionReqBody, options = {}) => {
// verify required parameter 'frameDeveloperManagedActionReqBody' is not null or undefined
(0, common_1.assertParamExists)('postFrameActionDeveloperManaged', 'frameDeveloperManagedActionReqBody', frameDeveloperManagedActionReqBody);
const localVarPath = `/farcaster/frame/developer_managed/action`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(frameDeveloperManagedActionReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Send notifications to interactors of a mini app
* @summary Send notifications
* @param {SendFrameNotificationsReqBody} sendFrameNotificationsReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<SendFrameNotificationsResponse>} A promise that resolves to a `SendFrameNotificationsResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-frame-notifications)
*
*/
publishFrameNotifications: async (sendFrameNotificationsReqBody, options = {}) => {
// verify required parameter 'sendFrameNotificationsReqBody' is not null or undefined
(0, common_1.assertParamExists)('publishFrameNotifications', 'sendFrameNotificationsReqBody', sendFrameNotificationsReqBody);
const localVarPath = `/farcaster/frame/notifications`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(sendFrameNotificationsReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Create a new mini app with a list of pages.
* @summary Create mini app
* @param {NeynarFrameCreationReqBody} neynarFrameCreationReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-neynar-frame)
*
*/
publishNeynarFrame: async (neynarFrameCreationReqBody, options = {}) => {
// verify required parameter 'neynarFrameCreationReqBody' is not null or undefined
(0, common_1.assertParamExists)('publishNeynarFrame', 'neynarFrameCreationReqBody', neynarFrameCreationReqBody);
const localVarPath = `/farcaster/frame`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(neynarFrameCreationReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Search for mini apps based on a query string
* @summary Search mini apps
* @param {string} q Query string to search for mini apps
* @param {number} [limit] Number of results to fetch (Default: 20, Maximum: 100)
* @param {string} [cursor] Pagination cursor
* @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/search-frames)
*
*/
searchFrames: async (q, limit, cursor, options = {}) => {
// verify required parameter 'q' is not null or undefined
(0, common_1.assertParamExists)('searchFrames', 'q', q);
const localVarPath = `/farcaster/frame/search`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
if (q !== undefined) {
localVarQueryParameter['q'] = q;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (cursor !== undefined) {
localVarQueryParameter['cursor'] = cursor;
}
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Update an existing mini app with a list of pages, if it was made by the developer (identified by API key)
* @summary Update mini app
* @param {NeynarFrameUpdateReqBody} neynarFrameUpdateReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<NeynarFrame>} A promise that resolves to a `NeynarFrame` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/update-neynar-frame)
*
*/
updateNeynarFrame: async (neynarFrameUpdateReqBody, options = {}) => {
// verify required parameter 'neynarFrameUpdateReqBody' is not null or undefined
(0, common_1.assertParamExists)('updateNeynarFrame', 'neynarFrameUpdateReqBody', neynarFrameUpdateReqBody);
const localVarPath = `/farcaster/frame`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(neynarFrameUpdateReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* 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.
* @throws {RequiredError}
* @returns {Promise<ValidateFrameActionResponse>} A promise that resolves to a `ValidateFrameActionResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/validate-frame-action)
*
*/
validateFrameAction: async (validateFrameActionReqBody, options = {}) => {
// verify required parameter 'validateFrameActionReqBody' is not null or undefined
(0, common_1.assertParamExists)('validateFrameAction', 'validateFrameActionReqBody', validateFrameActionReqBody);
const localVarPath = `/farcaster/frame/validate`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(validateFrameActionReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
exports.FrameApiAxiosParamCreator = FrameApiAxiosParamCreator;
/**
* FrameApi - functional programming interface
* @export
*/
const FrameApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.FrameApiAxiosParamCreator)(configuration);
return {
/**
* Delete an existing mini app, if it was made by the developer (identified by API key)
* @summary Delete mini app
* @param {DeleteFrameReqBody} deleteFrameReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<DeleteFrameResponse>} A promise that resolves to a `DeleteFrameResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-neynar-frame)
*
*/
async deleteNeynarFrame(deleteFrameReqBody, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNeynarFrame(deleteFrameReqBody, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.deleteNeynarFrame']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* A curated list of featured mini apps
* @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: `categories=games,social` OR: `categories=games&categories=social`
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FrameCatalogResponse>} A promise that resolves to a `FrameCatalogResponse` object
*
*/
async fetchFrameCatalog(limit, cursor, timeWindow, categories, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.fetchFrameCatalog(limit, cursor, timeWindow, categories, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.fetchFrameCatalog']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Fetches the mini app meta tags from the URL
* @summary Meta tags from URL
* @param {string} url The mini app URL to crawl
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<FetchFrameMetaTagsFromUrl200Response>} A promise that resolves to a `FetchFrameMetaTagsFromUrl200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-frame-meta-tags-from-url)
*
*/
async fetchFrameMetaTagsFromUrl(url, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.fetchFrameMetaTagsFromUrl(url, options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['FrameApi.fetchFrameMetaTagsFromUrl']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Fetch a list of mini apps made by the developer (identified by API key)
* @summary List of mini apps
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Array<NeynarFrame>>} A promise that resolves to a `Array<NeynarFrame>` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-neynar-frames)
*
*/
async fetchNeynarFrames(options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.fetchNeynarFrames(options);
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configurati