@standard-crypto/farcaster-js-neynar
Version:
A tool for interacting with Farcaster via Neynar APIs.
154 lines • 7.88 kB
JavaScript
/* tslint:disable */
/* eslint-disable */
/**
* Farcaster API V2
* No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*
* The version of the OpenAPI document: 2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import globalAxios from 'axios';
// Some imports not used depending on template conditions
// @ts-ignore
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setSearchParams, toPathString, createRequestFunction } from '../common.js';
// @ts-ignore
import { BASE_PATH, BaseAPI } from '../base.js';
/**
* FeedApi - axios parameter creator
* @export
*/
export const FeedApiAxiosParamCreator = function (configuration) {
return {
/**
*
* @summary Retrieve casts based on filters
* @param {'following' | 'filter'} feedType Defaults to following (requires fid or address). If set to filter (requires filter_type)
* @param {'fids' | 'parent_url' | 'global_trending'} [filterType] Used when feed_type=filter. Can be set to fids (requires fids) or parent_url (requires parent_url)
* @param {number} [fid] (Optional) fid of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type
* @param {string} [fids] Used when filter_type=fids . Create a feed based on a list of fids. Max array size is 250. Requires feed_type and filter_type.
* @param {string} [parentUrl] Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type
* @param {string} [cursor] Pagination cursor.
* @param {number} [limit] Number of results to retrieve (default 25, max 100)
* @param {boolean} [withRecasts] Include recasts in the response, true by default
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
feed: async (feedType, filterType, fid, fids, parentUrl, cursor, limit, withRecasts, options = {}) => {
// verify required parameter 'feedType' is not null or undefined
assertParamExists('feed', 'feedType', feedType);
const localVarPath = `/farcaster/feed`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication ApiKeyAuth required
await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration);
if (feedType !== undefined) {
localVarQueryParameter['feed_type'] = feedType;
}
if (filterType !== undefined) {
localVarQueryParameter['filter_type'] = filterType;
}
if (fid !== undefined) {
localVarQueryParameter['fid'] = fid;
}
if (fids !== undefined) {
localVarQueryParameter['fids'] = fids;
}
if (parentUrl !== undefined) {
localVarQueryParameter['parent_url'] = parentUrl;
}
if (cursor !== undefined) {
localVarQueryParameter['cursor'] = cursor;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (withRecasts !== undefined) {
localVarQueryParameter['with_recasts'] = withRecasts;
}
setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
/**
* FeedApi - functional programming interface
* @export
*/
export const FeedApiFp = function (configuration) {
const localVarAxiosParamCreator = FeedApiAxiosParamCreator(configuration);
return {
/**
*
* @summary Retrieve casts based on filters
* @param {'following' | 'filter'} feedType Defaults to following (requires fid or address). If set to filter (requires filter_type)
* @param {'fids' | 'parent_url' | 'global_trending'} [filterType] Used when feed_type=filter. Can be set to fids (requires fids) or parent_url (requires parent_url)
* @param {number} [fid] (Optional) fid of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type
* @param {string} [fids] Used when filter_type=fids . Create a feed based on a list of fids. Max array size is 250. Requires feed_type and filter_type.
* @param {string} [parentUrl] Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type
* @param {string} [cursor] Pagination cursor.
* @param {number} [limit] Number of results to retrieve (default 25, max 100)
* @param {boolean} [withRecasts] Include recasts in the response, true by default
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async feed(feedType, filterType, fid, fids, parentUrl, cursor, limit, withRecasts, options) {
const localVarAxiosArgs = await localVarAxiosParamCreator.feed(feedType, filterType, fid, fids, parentUrl, cursor, limit, withRecasts, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
};
};
/**
* FeedApi - factory interface
* @export
*/
export const FeedApiFactory = function (configuration, basePath, axios) {
const localVarFp = FeedApiFp(configuration);
return {
/**
*
* @summary Retrieve casts based on filters
* @param {FeedApiFeedRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
feed(requestParameters, options) {
return localVarFp.feed(requestParameters.feedType, requestParameters.filterType, requestParameters.fid, requestParameters.fids, requestParameters.parentUrl, requestParameters.cursor, requestParameters.limit, requestParameters.withRecasts, options).then((request) => request(axios, basePath));
},
};
};
/**
* FeedApi - object-oriented interface
* @export
* @class FeedApi
* @extends {BaseAPI}
*/
export class FeedApi extends BaseAPI {
/**
*
* @summary Retrieve casts based on filters
* @param {FeedApiFeedRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof FeedApi
*/
feed(requestParameters, options) {
return FeedApiFp(this.configuration).feed(requestParameters.feedType, requestParameters.filterType, requestParameters.fid, requestParameters.fids, requestParameters.parentUrl, requestParameters.cursor, requestParameters.limit, requestParameters.withRecasts, options).then((request) => request(this.axios, this.basePath));
}
}
//# sourceMappingURL=feed-api.js.map