@hawksightco/swagger-client/dist/apis/orca-utility-functions-api.d.ts

OpenAPI client for Hawksight v2 Public API

/**
 * Hawksight API
 * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { AxiosResponse, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { InlineResponse2004 } from '../models';
import { InlineResponse2005 } from '../models';
import { OrcaPositionMint } from '../models';
import { UtilActiveTickBody } from '../models';
/**
 * OrcaUtilityFunctionsApi - axios parameter creator
 * @export
 */
export declare const OrcaUtilityFunctionsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Returns orca tick current index of given whirlpool(s)
     * @param {UtilActiveTickBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilActiveTickPost: (body: UtilActiveTickBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns orca position mint from given position
     * @param {string} [position] Orca position address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilGetPositionMintGet: (position?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns a list of active Orca whirlpools on Hawksight with detailed information about each pool.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilPoolsGet: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns Orca positions of user
     * @param {string} wallet User&#x27;s wallet address who owns the position
     * @param {string} [pool] Orca whirlpool address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilPositionsGet: (wallet: string, pool?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * OrcaUtilityFunctionsApi - functional programming interface
 * @export
 */
export declare const OrcaUtilityFunctionsApiFp: (configuration?: Configuration) => {
    /**
     * Returns orca tick current index of given whirlpool(s)
     * @param {UtilActiveTickBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilActiveTickPost(body: UtilActiveTickBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<{
        [key: string]: number;
    }>>>;
    /**
     * Returns orca position mint from given position
     * @param {string} [position] Orca position address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilGetPositionMintGet(position?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<OrcaPositionMint>>>;
    /**
     * Returns a list of active Orca whirlpools on Hawksight with detailed information about each pool.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilPoolsGet(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<InlineResponse2005>>>>;
    /**
     * Returns Orca positions of user
     * @param {string} wallet User&#x27;s wallet address who owns the position
     * @param {string} [pool] Orca whirlpool address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilPositionsGet(wallet: string, pool?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2004>>>;
};
/**
 * OrcaUtilityFunctionsApi - factory interface
 * @export
 */
export declare const OrcaUtilityFunctionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Returns orca tick current index of given whirlpool(s)
     * @param {UtilActiveTickBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilActiveTickPost(body: UtilActiveTickBody, options?: AxiosRequestConfig): Promise<AxiosResponse<{
        [key: string]: number;
    }>>;
    /**
     * Returns orca position mint from given position
     * @param {string} [position] Orca position address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilGetPositionMintGet(position?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<OrcaPositionMint>>;
    /**
     * Returns a list of active Orca whirlpools on Hawksight with detailed information about each pool.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilPoolsGet(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2005>>>;
    /**
     * Returns Orca positions of user
     * @param {string} wallet User&#x27;s wallet address who owns the position
     * @param {string} [pool] Orca whirlpool address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    orcaUtilPositionsGet(wallet: string, pool?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2004>>;
};
/**
 * OrcaUtilityFunctionsApi - object-oriented interface
 * @export
 * @class OrcaUtilityFunctionsApi
 * @extends {BaseAPI}
 */
export declare class OrcaUtilityFunctionsApi extends BaseAPI {
    /**
     * Returns orca tick current index of given whirlpool(s)
     * @param {UtilActiveTickBody} body
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OrcaUtilityFunctionsApi
     */
    orcaUtilActiveTickPost(body: UtilActiveTickBody, options?: AxiosRequestConfig): Promise<AxiosResponse<{
        [key: string]: number;
    }>>;
    /**
     * Returns orca position mint from given position
     * @param {string} [position] Orca position address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OrcaUtilityFunctionsApi
     */
    orcaUtilGetPositionMintGet(position?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<OrcaPositionMint>>;
    /**
     * Returns a list of active Orca whirlpools on Hawksight with detailed information about each pool.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OrcaUtilityFunctionsApi
     */
    orcaUtilPoolsGet(options?: AxiosRequestConfig): Promise<AxiosResponse<Array<InlineResponse2005>>>;
    /**
     * Returns Orca positions of user
     * @param {string} wallet User&#x27;s wallet address who owns the position
     * @param {string} [pool] Orca whirlpool address
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof OrcaUtilityFunctionsApi
     */
    orcaUtilPositionsGet(wallet: string, pool?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2004>>;
}