@hawksightco/swagger-client
Version:
OpenAPI client for Hawksight v2 Public API
144 lines (143 loc) • 6.83 kB
TypeScript
/**
* 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 { InlineResponse2002 } from '../models';
import { PriorityFeeEstimate } from '../models';
import { UtilFindAltWithTxBody } from '../models';
import { UtilGetPriorityFeeEstimateBody } from '../models';
/**
* GeneralUtilityEndpointsApi - axios parameter creator
* @export
*/
export declare const GeneralUtilityEndpointsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Returns OLHCV data of a given contract address from Birdeye
* @param {string} address The contract address.
* @param {string} timeframe Candlestick timeframe
* @param {number} timeFrom the start time in seconds.
* @param {number} timeTo The end time in seconds.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilCandlestickGet: (address: string, timeframe: string, timeFrom: number, timeTo: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Find address lookup tables from Jupiter from given transaction metadata.
* @param {UtilFindAltWithTxBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilFindAltWithTxPost: (body: UtilFindAltWithTxBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
* Computes fees from given hawksight transaction.
* @param {UtilGetPriorityFeeEstimateBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilGetPriorityFeeEstimatePost: (body: UtilGetPriorityFeeEstimateBody, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* GeneralUtilityEndpointsApi - functional programming interface
* @export
*/
export declare const GeneralUtilityEndpointsApiFp: (configuration?: Configuration) => {
/**
* Returns OLHCV data of a given contract address from Birdeye
* @param {string} address The contract address.
* @param {string} timeframe Candlestick timeframe
* @param {number} timeFrom the start time in seconds.
* @param {number} timeTo The end time in seconds.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilCandlestickGet(address: string, timeframe: string, timeFrom: number, timeTo: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<InlineResponse2002>>>;
/**
* Find address lookup tables from Jupiter from given transaction metadata.
* @param {UtilFindAltWithTxBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilFindAltWithTxPost(body: UtilFindAltWithTxBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<string>>>>;
/**
* Computes fees from given hawksight transaction.
* @param {UtilGetPriorityFeeEstimateBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilGetPriorityFeeEstimatePost(body: UtilGetPriorityFeeEstimateBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<PriorityFeeEstimate>>>;
};
/**
* GeneralUtilityEndpointsApi - factory interface
* @export
*/
export declare const GeneralUtilityEndpointsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Returns OLHCV data of a given contract address from Birdeye
* @param {string} address The contract address.
* @param {string} timeframe Candlestick timeframe
* @param {number} timeFrom the start time in seconds.
* @param {number} timeTo The end time in seconds.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilCandlestickGet(address: string, timeframe: string, timeFrom: number, timeTo: number, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2002>>;
/**
* Find address lookup tables from Jupiter from given transaction metadata.
* @param {UtilFindAltWithTxBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilFindAltWithTxPost(body: UtilFindAltWithTxBody, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<string>>>;
/**
* Computes fees from given hawksight transaction.
* @param {UtilGetPriorityFeeEstimateBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
utilGetPriorityFeeEstimatePost(body: UtilGetPriorityFeeEstimateBody, options?: AxiosRequestConfig): Promise<AxiosResponse<PriorityFeeEstimate>>;
};
/**
* GeneralUtilityEndpointsApi - object-oriented interface
* @export
* @class GeneralUtilityEndpointsApi
* @extends {BaseAPI}
*/
export declare class GeneralUtilityEndpointsApi extends BaseAPI {
/**
* Returns OLHCV data of a given contract address from Birdeye
* @param {string} address The contract address.
* @param {string} timeframe Candlestick timeframe
* @param {number} timeFrom the start time in seconds.
* @param {number} timeTo The end time in seconds.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralUtilityEndpointsApi
*/
utilCandlestickGet(address: string, timeframe: string, timeFrom: number, timeTo: number, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2002>>;
/**
* Find address lookup tables from Jupiter from given transaction metadata.
* @param {UtilFindAltWithTxBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralUtilityEndpointsApi
*/
utilFindAltWithTxPost(body: UtilFindAltWithTxBody, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<string>>>;
/**
* Computes fees from given hawksight transaction.
* @param {UtilGetPriorityFeeEstimateBody} body
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof GeneralUtilityEndpointsApi
*/
utilGetPriorityFeeEstimatePost(body: UtilGetPriorityFeeEstimateBody, options?: AxiosRequestConfig): Promise<AxiosResponse<PriorityFeeEstimate>>;
}