@standard-crypto/farcaster-js-warpcast/dist/commonjs/openapi/generated/apis/users-api.d.ts

A tool for interacting with the private APIs of the Warpcast client.

/**
 * Warpcast API
 * Private API used by the Warpcast client
 *
 * The version of the OpenAPI document: 1.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 type { Configuration } from '../configuration.js';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
import { RequestArgs, BaseAPI } from '../base.js';
import { V2OnboardingStateGet200Response } from '../models/index.js';
import { V2UserGet200Response } from '../models/index.js';
/**
 * UsersApi - axios parameter creator
 * @export
 */
export declare const UsersApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2OnboardingStateGet: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} fid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2UserGet: (fid: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * UsersApi - functional programming interface
 * @export
 */
export declare const UsersApiFp: (configuration?: Configuration) => {
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2OnboardingStateGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2OnboardingStateGet200Response>>;
    /**
     *
     * @param {number} fid
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2UserGet(fid: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<V2UserGet200Response>>;
};
/**
 * UsersApi - factory interface
 * @export
 */
export declare const UsersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2OnboardingStateGet(options?: AxiosRequestConfig): AxiosPromise<V2OnboardingStateGet200Response>;
    /**
     *
     * @param {UsersApiV2UserGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    v2UserGet(requestParameters: UsersApiV2UserGetRequest, options?: AxiosRequestConfig): AxiosPromise<V2UserGet200Response>;
};
/**
 * Request parameters for v2UserGet operation in UsersApi.
 * @export
 * @interface UsersApiV2UserGetRequest
 */
export interface UsersApiV2UserGetRequest {
    /**
     *
     * @type {number}
     * @memberof UsersApiV2UserGet
     */
    readonly fid: number;
}
/**
 * UsersApi - object-oriented interface
 * @export
 * @class UsersApi
 * @extends {BaseAPI}
 */
export declare class UsersApi extends BaseAPI {
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    v2OnboardingStateGet(options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<V2OnboardingStateGet200Response, any>>;
    /**
     *
     * @param {UsersApiV2UserGetRequest} requestParameters Request parameters.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof UsersApi
     */
    v2UserGet(requestParameters: UsersApiV2UserGetRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<V2UserGet200Response, any>>;
}