@bitmovin/api-sdk
Version:
Bitmovin JS/TS API SDK
45 lines (44 loc) • 1.61 kB
TypeScript
import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import HttpInput from '../../../models/HttpInput';
import PaginationResponse from '../../../models/PaginationResponse';
import { HttpInputListQueryParams, HttpInputListQueryParamsBuilder } from './HttpInputListQueryParams';
/**
* HttpApi - object-oriented interface
* @export
* @class HttpApi
* @extends {BaseAPI}
*/
export default class HttpApi extends BaseAPI {
customdata: CustomdataApi;
constructor(configuration: Configuration);
/**
* @summary Create HTTP Input
* @param {HttpInput} httpInput The HTTP input to be created
* @throws {BitmovinError}
* @memberof HttpApi
*/
create(httpInput?: HttpInput): Promise<HttpInput>;
/**
* @summary Delete HTTP Input
* @param {string} inputId Id of the input
* @throws {BitmovinError}
* @memberof HttpApi
*/
delete(inputId: string): Promise<HttpInput>;
/**
* @summary HTTP Input Details
* @param {string} inputId Id of the input
* @throws {BitmovinError}
* @memberof HttpApi
*/
get(inputId: string): Promise<HttpInput>;
/**
* @summary List HTTP Inputs
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
* @throws {BitmovinError}
* @memberof HttpApi
*/
list(queryParameters?: HttpInputListQueryParams | ((q: HttpInputListQueryParamsBuilder) => HttpInputListQueryParamsBuilder)): Promise<PaginationResponse<HttpInput>>;
}