UNPKG

@hubbleprotocol/carpool-typescript-client

Version:

OpenAPI TypeScript client for Carpool

171 lines (170 loc) 12.2 kB
/** * Carpool Query * The Carpool Query API * * OpenAPI spec version: 1.0 * * * 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'; /** * LogsApi - axios parameter creator * @export */ export declare const LogsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logsControllerSearchProgramLogs: (xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logsControllerSearchProgramLogs_1: (xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; }; /** * LogsApi - functional programming interface * @export */ export declare const LogsApiFp: (configuration?: Configuration) => { /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logsControllerSearchProgramLogs(xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logsControllerSearchProgramLogs_1(xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; }; /** * LogsApi - factory interface * @export */ export declare const LogsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logsControllerSearchProgramLogs(xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logsControllerSearchProgramLogs_1(xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; }; /** * LogsApi - object-oriented interface * @export * @class LogsApi * @extends {BaseAPI} */ export declare class LogsApi extends BaseAPI { /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LogsApi */ logsControllerSearchProgramLogsDevnet(xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; /** * Query transaction logs with full text search and receive matching instructions. Note that logs are scoped to each instruction invocation and CPI logs are not included. * @summary Search instructions for matching logs. * @param {string} xApiKey * @param {string} programId * @param {string} q Elasticsearch querystring. See &lt;a href&#x3D;\&quot;https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\&quot; target&#x3D;\&quot;_blank\&quot;&gt;the Elasticsearch docs&lt;/a&gt; for more. * @param {string} [instructionName] A specific instruction name to search though. * @param {number} [size] Number of entries to return. Default is 10. * @param {number} [from] Pagination starting point. * @param {number} [start] A starting slot for the search (inclusive) * @param {number} [end] An ending slot for the search (exclusive) * @param {string} [sort] Slot sort order for results. Defaults to \&quot;desc\&quot;. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LogsApi */ logsControllerSearchProgramLogsMainnet(xApiKey: string, programId: string, q: string, instructionName?: string, size?: number, from?: number, start?: number, end?: number, sort?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; }