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