@neynar/nodejs-sdk/build/api/apis/fname-api.d.ts

SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)

/**
 * 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.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { FnameAvailabilityResponse } from '../models';
/**
 * FnameApi - axios parameter creator
 * @export
 */
export declare const FnameApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Check if a given fname is available
     * @summary Check fname availability
     * @param {string} fname
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FnameAvailabilityResponse>} A promise that resolves to a `FnameAvailabilityResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/is-fname-available)
     *
     */
    isFnameAvailable: (fname: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * FnameApi - functional programming interface
 * @export
 */
export declare const FnameApiFp: (configuration?: Configuration) => {
    /**
     * Check if a given fname is available
     * @summary Check fname availability
     * @param {string} fname
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FnameAvailabilityResponse>} A promise that resolves to a `FnameAvailabilityResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/is-fname-available)
     *
     */
    isFnameAvailable(fname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FnameAvailabilityResponse>>;
};
/**
 * FnameApi - factory interface
 * @export
 */
export declare const FnameApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Check if a given fname is available
     * @summary Check fname availability
     * @param {FnameApiIsFnameAvailableRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @returns {Promise<FnameAvailabilityResponse>} A promise that resolves to a `FnameAvailabilityResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/is-fname-available)
     *
     */
    isFnameAvailable(requestParameters: FnameApiIsFnameAvailableRequest, options?: RawAxiosRequestConfig): AxiosPromise<FnameAvailabilityResponse>;
};
/**
 * FnameApi - interface
 * @export
 * @interface FnameApi
 */
export interface FnameApiInterface {
    /**
     * Check if a given fname is available
     * @summary Check fname availability
     * @param {FnameApiIsFnameAvailableRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FnameApiInterface
     * @returns {Promise<FnameAvailabilityResponse>} A promise that resolves to a `FnameAvailabilityResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/is-fname-available)
     *
     */
    isFnameAvailable(requestParameters: FnameApiIsFnameAvailableRequest, options?: RawAxiosRequestConfig): AxiosPromise<FnameAvailabilityResponse>;
}
/**
 * Request parameters for isFnameAvailable operation in FnameApi.
 * @export
 * @interface FnameApiIsFnameAvailableRequest
 */
export interface FnameApiIsFnameAvailableRequest {
    /**
     *
     *
     *
     *
     * @type {string}
     * @memberof FnameApiIsFnameAvailable
     */
    readonly fname: string;
}
/**
 * FnameApi - object-oriented interface
 * @export
 * @class FnameApi
 * @extends {BaseAPI}
 */
export declare class FnameApi extends BaseAPI implements FnameApiInterface {
    /**
     * Check if a given fname is available
     * @summary Check fname availability
     * @param {FnameApiIsFnameAvailableRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof FnameApi
     * @returns {Promise<FnameAvailabilityResponse>} A promise that resolves to a `FnameAvailabilityResponse` object
     *
     * For more information, refer to the [API documentation](https://docs.neynar.com/reference/is-fname-available)
     *
     */
    isFnameAvailable(requestParameters: FnameApiIsFnameAvailableRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FnameAvailabilityResponse, any, {}>>;
}