jack-kafka-instance-sdk
Version:
RHOAS Kafka Instance Adminstration SDK
128 lines (127 loc) • 4.1 kB
TypeScript
/**
* Kafka Instance API
* API for interacting with Kafka Instance. Includes Produce, Consume and Admin APIs
*
* The version of the OpenAPI document: 0.14.1-SNAPSHOT
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { ErrorList } from '../model';
/**
* ErrorsApi - axios parameter creator
* @export
*/
export declare const ErrorsApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Get an error by its unique ID
* @param {string} errorId Error identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getError: (errorId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Get list of errors
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getErrors: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* ErrorsApi - functional programming interface
* @export
*/
export declare const ErrorsApiFp: (configuration?: Configuration) => {
/**
*
* @summary Get an error by its unique ID
* @param {string} errorId Error identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getError(errorId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Error>>;
/**
*
* @summary Get list of errors
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getErrors(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ErrorList>>;
};
/**
* ErrorsApi - factory interface
* @export
*/
export declare const ErrorsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Get an error by its unique ID
* @param {string} errorId Error identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getError(errorId: string, options?: any): AxiosPromise<Error>;
/**
*
* @summary Get list of errors
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getErrors(options?: any): AxiosPromise<ErrorList>;
};
/**
* ErrorsApi - interface
* @export
* @interface ErrorsApi
*/
export interface ErrorsApiInterface {
/**
*
* @summary Get an error by its unique ID
* @param {string} errorId Error identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ErrorsApiInterface
*/
getError(errorId: string, options?: AxiosRequestConfig): AxiosPromise<Error>;
/**
*
* @summary Get list of errors
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ErrorsApiInterface
*/
getErrors(options?: AxiosRequestConfig): AxiosPromise<ErrorList>;
}
/**
* ErrorsApi - object-oriented interface
* @export
* @class ErrorsApi
* @extends {BaseAPI}
*/
export declare class ErrorsApi extends BaseAPI implements ErrorsApiInterface {
/**
*
* @summary Get an error by its unique ID
* @param {string} errorId Error identifier
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ErrorsApi
*/
getError(errorId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Error, any>>;
/**
*
* @summary Get list of errors
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof ErrorsApi
*/
getErrors(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ErrorList, any>>;
}