UNPKG

@standard-crypto/farcaster-js-neynar

Version:

A tool for interacting with Farcaster via Neynar APIs.

581 lines 30.7 kB
/* 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, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common.js'; // @ts-ignore import { BASE_PATH, BaseAPI } from '../base.js'; /** * UserApi - axios parameter creator * @export */ export const UserApiAxiosParamCreator = function (configuration) { return { /** * Removes verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Removes verification for an eth address for the user * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ farcasterUserVerificationDelete: async (removeVerificationReqBody, options = {}) => { // verify required parameter 'removeVerificationReqBody' is not null or undefined assertParamExists('farcasterUserVerificationDelete', 'removeVerificationReqBody', removeVerificationReqBody); const localVarPath = `/farcaster/user/verification`; // 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: 'DELETE', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration); localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded(removeVerificationReqBody, localVarRequestOptions, configuration); return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Adds verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Adds verification for an eth address for the user * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ farcasterUserVerificationPost: async (addVerificationReqBody, options = {}) => { // verify required parameter 'addVerificationReqBody' is not null or undefined assertParamExists('farcasterUserVerificationPost', 'addVerificationReqBody', addVerificationReqBody); const localVarPath = `/farcaster/user/verification`; // 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: 'POST', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration); localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded(addVerificationReqBody, localVarRequestOptions, configuration); return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow a user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ followUser: async (followReqBody, options = {}) => { // verify required parameter 'followReqBody' is not null or undefined assertParamExists('followUser', 'followReqBody', followReqBody); const localVarPath = `/farcaster/user/follow`; // 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: 'POST', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration); localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded(followReqBody, localVarRequestOptions, configuration); return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Lookup a user by custody-address * @summary Lookup a user by custody-address * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} */ lookupUserByCustodyAddress: async (custodyAddress, options = {}) => { // verify required parameter 'custodyAddress' is not null or undefined assertParamExists('lookupUserByCustodyAddress', 'custodyAddress', custodyAddress); const localVarPath = `/farcaster/user/custody-address`; // 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 (custodyAddress !== undefined) { localVarQueryParameter['custody_address'] = custodyAddress; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow a user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ unfollowUser: async (followReqBody, options = {}) => { // verify required parameter 'followReqBody' is not null or undefined assertParamExists('unfollowUser', 'followReqBody', followReqBody); const localVarPath = `/farcaster/user/follow`; // 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: 'DELETE', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration); localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded(followReqBody, localVarRequestOptions, configuration); return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser: async (updateUserReqBody, options = {}) => { // verify required parameter 'updateUserReqBody' is not null or undefined assertParamExists('updateUser', 'updateUserReqBody', updateUserReqBody); const localVarPath = `/farcaster/user`; // 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: 'PATCH', ...baseOptions, ...options }; const localVarHeaderParameter = {}; const localVarQueryParameter = {}; // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "api_key", configuration); localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; localVarRequestOptions.data = serializeDataIfNeeded(updateUserReqBody, localVarRequestOptions, configuration); return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Fetches information about multiple users based on FIDs * @summary Fetches information about multiple users based on FIDs * @param {string} fids * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ userBulk: async (fids, viewerFid, options = {}) => { // verify required parameter 'fids' is not null or undefined assertParamExists('userBulk', 'fids', fids); const localVarPath = `/farcaster/user/bulk`; // 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 (fids !== undefined) { localVarQueryParameter['fids'] = fids; } if (viewerFid !== undefined) { localVarQueryParameter['viewer_fid'] = viewerFid; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, /** * Search for Usernames * @summary Search for Usernames * @param {number} viewerFid * @param {string} q * @param {*} [options] Override http request option. * @throws {RequiredError} */ userSearch: async (viewerFid, q, options = {}) => { // verify required parameter 'viewerFid' is not null or undefined assertParamExists('userSearch', 'viewerFid', viewerFid); // verify required parameter 'q' is not null or undefined assertParamExists('userSearch', 'q', q); const localVarPath = `/farcaster/user/search`; // 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 (viewerFid !== undefined) { localVarQueryParameter['viewer_fid'] = viewerFid; } if (q !== undefined) { localVarQueryParameter['q'] = q; } setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers }; return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, }; }, }; }; /** * UserApi - functional programming interface * @export */ export const UserApiFp = function (configuration) { const localVarAxiosParamCreator = UserApiAxiosParamCreator(configuration); return { /** * Removes verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Removes verification for an eth address for the user * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ async farcasterUserVerificationDelete(removeVerificationReqBody, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.farcasterUserVerificationDelete(removeVerificationReqBody, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Adds verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Adds verification for an eth address for the user * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ async farcasterUserVerificationPost(addVerificationReqBody, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.farcasterUserVerificationPost(addVerificationReqBody, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow a user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ async followUser(followReqBody, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.followUser(followReqBody, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Lookup a user by custody-address * @summary Lookup a user by custody-address * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} */ async lookupUserByCustodyAddress(custodyAddress, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.lookupUserByCustodyAddress(custodyAddress, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow a user * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ async unfollowUser(followReqBody, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.unfollowUser(followReqBody, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ async updateUser(updateUserReqBody, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(updateUserReqBody, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Fetches information about multiple users based on FIDs * @summary Fetches information about multiple users based on FIDs * @param {string} fids * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ async userBulk(fids, viewerFid, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.userBulk(fids, viewerFid, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Search for Usernames * @summary Search for Usernames * @param {number} viewerFid * @param {string} q * @param {*} [options] Override http request option. * @throws {RequiredError} */ async userSearch(viewerFid, q, options) { const localVarAxiosArgs = await localVarAxiosParamCreator.userSearch(viewerFid, q, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, }; }; /** * UserApi - factory interface * @export */ export const UserApiFactory = function (configuration, basePath, axios) { const localVarFp = UserApiFp(configuration); return { /** * Removes verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Removes verification for an eth address for the user * @param {UserApiFarcasterUserVerificationDeleteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ farcasterUserVerificationDelete(requestParameters, options) { return localVarFp.farcasterUserVerificationDelete(requestParameters.removeVerificationReqBody, options).then((request) => request(axios, basePath)); }, /** * Adds verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Adds verification for an eth address for the user * @param {UserApiFarcasterUserVerificationPostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ farcasterUserVerificationPost(requestParameters, options) { return localVarFp.farcasterUserVerificationPost(requestParameters.addVerificationReqBody, options).then((request) => request(axios, basePath)); }, /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow a user * @param {UserApiFollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ followUser(requestParameters, options) { return localVarFp.followUser(requestParameters.followReqBody, options).then((request) => request(axios, basePath)); }, /** * Lookup a user by custody-address * @summary Lookup a user by custody-address * @param {UserApiLookupUserByCustodyAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ lookupUserByCustodyAddress(requestParameters, options) { return localVarFp.lookupUserByCustodyAddress(requestParameters.custodyAddress, options).then((request) => request(axios, basePath)); }, /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow a user * @param {UserApiUnfollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unfollowUser(requestParameters, options) { return localVarFp.unfollowUser(requestParameters.followReqBody, options).then((request) => request(axios, basePath)); }, /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUser(requestParameters, options) { return localVarFp.updateUser(requestParameters.updateUserReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetches information about multiple users based on FIDs * @summary Fetches information about multiple users based on FIDs * @param {UserApiUserBulkRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userBulk(requestParameters, options) { return localVarFp.userBulk(requestParameters.fids, requestParameters.viewerFid, options).then((request) => request(axios, basePath)); }, /** * Search for Usernames * @summary Search for Usernames * @param {UserApiUserSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ userSearch(requestParameters, options) { return localVarFp.userSearch(requestParameters.viewerFid, requestParameters.q, options).then((request) => request(axios, basePath)); }, }; }; /** * UserApi - object-oriented interface * @export * @class UserApi * @extends {BaseAPI} */ export class UserApi extends BaseAPI { /** * Removes verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Removes verification for an eth address for the user * @param {UserApiFarcasterUserVerificationDeleteRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ farcasterUserVerificationDelete(requestParameters, options) { return UserApiFp(this.configuration).farcasterUserVerificationDelete(requestParameters.removeVerificationReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Adds verification for an eth address for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Adds verification for an eth address for the user * @param {UserApiFarcasterUserVerificationPostRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ farcasterUserVerificationPost(requestParameters, options) { return UserApiFp(this.configuration).farcasterUserVerificationPost(requestParameters.addVerificationReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow a user * @param {UserApiFollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ followUser(requestParameters, options) { return UserApiFp(this.configuration).followUser(requestParameters.followReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Lookup a user by custody-address * @summary Lookup a user by custody-address * @param {UserApiLookupUserByCustodyAddressRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ lookupUserByCustodyAddress(requestParameters, options) { return UserApiFp(this.configuration).lookupUserByCustodyAddress(requestParameters.custodyAddress, options).then((request) => request(this.axios, this.basePath)); } /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow a user * @param {UserApiUnfollowUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ unfollowUser(requestParameters, options) { return UserApiFp(this.configuration).unfollowUser(requestParameters.followReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile * @param {UserApiUpdateUserRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ updateUser(requestParameters, options) { return UserApiFp(this.configuration).updateUser(requestParameters.updateUserReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches information about multiple users based on FIDs * @summary Fetches information about multiple users based on FIDs * @param {UserApiUserBulkRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ userBulk(requestParameters, options) { return UserApiFp(this.configuration).userBulk(requestParameters.fids, requestParameters.viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Search for Usernames * @summary Search for Usernames * @param {UserApiUserSearchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ userSearch(requestParameters, options) { return UserApiFp(this.configuration).userSearch(requestParameters.viewerFid, requestParameters.q, options).then((request) => request(this.axios, this.basePath)); } } //# sourceMappingURL=user-api.js.map