@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
334 lines (333 loc) • 18.6 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* 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: 3.115.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.BlockApi = exports.BlockApiFactory = exports.BlockApiFp = exports.BlockApiAxiosParamCreator = 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");
/**
* BlockApi - axios parameter creator
* @export
*/
const BlockApiAxiosParamCreator = function (configuration) {
return {
/**
* Deletes a block for a given FID.
* @summary Unblock FID
* @param {BlockReqBody} blockReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-block)
*
*/
deleteBlock: async (blockReqBody, options = {}) => {
// verify required parameter 'blockReqBody' is not null or undefined
(0, common_1.assertParamExists)('deleteBlock', 'blockReqBody', blockReqBody);
const localVarPath = `/v2/farcaster/block/`;
// 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)(blockReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Fetches all FIDs that a user has blocked or has been blocked by
* @summary Blocked / Blocked by FIDs
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {number} [blockerFid] Providing this will return the users that this user has blocked
* @param {number} [blockedFid] Providing this will return the users that have blocked this user
* @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<BlockListResponse>} A promise that resolves to a `BlockListResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-block-list)
*
*/
fetchBlockList: async (xNeynarExperimental, blockerFid, blockedFid, limit, cursor, options = {}) => {
const localVarPath = `/v2/farcaster/block/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);
if (blockerFid !== undefined) {
localVarQueryParameter['blocker_fid'] = blockerFid;
}
if (blockedFid !== undefined) {
localVarQueryParameter['blocked_fid'] = blockedFid;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (cursor !== undefined) {
localVarQueryParameter['cursor'] = cursor;
}
if (xNeynarExperimental != null) {
localVarHeaderParameter['x-neynar-experimental'] = typeof xNeynarExperimental === 'string'
? xNeynarExperimental
: JSON.stringify(xNeynarExperimental);
}
(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,
};
},
/**
* Adds a block for a given FID.
* @summary Block FID
* @param {BlockReqBody} blockReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-block)
*
*/
publishBlock: async (blockReqBody, options = {}) => {
// verify required parameter 'blockReqBody' is not null or undefined
(0, common_1.assertParamExists)('publishBlock', 'blockReqBody', blockReqBody);
const localVarPath = `/v2/farcaster/block/`;
// 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)(blockReqBody, localVarRequestOptions, configuration);
return {
url: (0, common_1.toPathString)(localVarUrlObj),
options: localVarRequestOptions,
};
},
};
};
exports.BlockApiAxiosParamCreator = BlockApiAxiosParamCreator;
/**
* BlockApi - functional programming interface
* @export
*/
const BlockApiFp = function (configuration) {
const localVarAxiosParamCreator = (0, exports.BlockApiAxiosParamCreator)(configuration);
return {
/**
* Deletes a block for a given FID.
* @summary Unblock FID
* @param {BlockReqBody} blockReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-block)
*
*/
async deleteBlock(blockReqBody, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBlock(blockReqBody, 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['BlockApi.deleteBlock']) === 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 all FIDs that a user has blocked or has been blocked by
* @summary Blocked / Blocked by FIDs
* @param {boolean} [xNeynarExperimental] Enables experimental features including filtering based on the Neynar score. See [docs](https://neynar.notion.site/Experimental-Features-1d2655195a8b80eb98b4d4ae7b76ae4a) for more details.
* @param {number} [blockerFid] Providing this will return the users that this user has blocked
* @param {number} [blockedFid] Providing this will return the users that have blocked this user
* @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<BlockListResponse>} A promise that resolves to a `BlockListResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-block-list)
*
*/
async fetchBlockList(xNeynarExperimental, blockerFid, blockedFid, limit, cursor, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.fetchBlockList(xNeynarExperimental, blockerFid, blockedFid, limit, cursor, 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['BlockApi.fetchBlockList']) === 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);
},
/**
* Adds a block for a given FID.
* @summary Block FID
* @param {BlockReqBody} blockReqBody
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-block)
*
*/
async publishBlock(blockReqBody, options) {
var _a, _b, _c;
const localVarAxiosArgs = await localVarAxiosParamCreator.publishBlock(blockReqBody, 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['BlockApi.publishBlock']) === 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);
},
};
};
exports.BlockApiFp = BlockApiFp;
/**
* BlockApi - factory interface
* @export
*/
const BlockApiFactory = function (configuration, basePath, axios) {
const localVarFp = (0, exports.BlockApiFp)(configuration);
return {
/**
* Deletes a block for a given FID.
* @summary Unblock FID
* @param {BlockApiDeleteBlockRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-block)
*
*/
deleteBlock(requestParameters, options) {
return localVarFp.deleteBlock(requestParameters.blockReqBody, options).then((request) => request(axios, basePath));
},
/**
* Fetches all FIDs that a user has blocked or has been blocked by
* @summary Blocked / Blocked by FIDs
* @param {BlockApiFetchBlockListRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<BlockListResponse>} A promise that resolves to a `BlockListResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-block-list)
*
*/
fetchBlockList(requestParameters = {}, options) {
return localVarFp.fetchBlockList(requestParameters.xNeynarExperimental, requestParameters.blockerFid, requestParameters.blockedFid, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
},
/**
* Adds a block for a given FID.
* @summary Block FID
* @param {BlockApiPublishBlockRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-block)
*
*/
publishBlock(requestParameters, options) {
return localVarFp.publishBlock(requestParameters.blockReqBody, options).then((request) => request(axios, basePath));
},
};
};
exports.BlockApiFactory = BlockApiFactory;
/**
* BlockApi - object-oriented interface
* @export
* @class BlockApi
* @extends {BaseAPI}
*/
class BlockApi extends base_1.BaseAPI {
/**
* Deletes a block for a given FID.
* @summary Unblock FID
* @param {BlockApiDeleteBlockRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BlockApi
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/delete-block)
*
*/
deleteBlock(requestParameters, options) {
return (0, exports.BlockApiFp)(this.configuration).deleteBlock(requestParameters.blockReqBody, options).then((request) => request(this.axios, this.basePath));
}
/**
* Fetches all FIDs that a user has blocked or has been blocked by
* @summary Blocked / Blocked by FIDs
* @param {BlockApiFetchBlockListRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BlockApi
* @returns {Promise<BlockListResponse>} A promise that resolves to a `BlockListResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-block-list)
*
*/
fetchBlockList(requestParameters = {}, options) {
return (0, exports.BlockApiFp)(this.configuration).fetchBlockList(requestParameters.xNeynarExperimental, requestParameters.blockerFid, requestParameters.blockedFid, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
}
/**
* Adds a block for a given FID.
* @summary Block FID
* @param {BlockApiPublishBlockRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof BlockApi
* @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/publish-block)
*
*/
publishBlock(requestParameters, options) {
return (0, exports.BlockApiFp)(this.configuration).publishBlock(requestParameters.blockReqBody, options).then((request) => request(this.axios, this.basePath));
}
}
exports.BlockApi = BlockApi;