@bitmovin/api-sdk/dist/encoding/inputs/aspera/AsperaApi.d.ts

Bitmovin JS/TS API SDK

import { BaseAPI } from '../../../common/BaseAPI';
import Configuration from '../../../common/Configuration';
import CustomdataApi from './customdata/CustomdataApi';
import AsperaInput from '../../../models/AsperaInput';
import PaginationResponse from '../../../models/PaginationResponse';
import { AsperaInputListQueryParams, AsperaInputListQueryParamsBuilder } from './AsperaInputListQueryParams';
/**
 * AsperaApi - object-oriented interface
 * @export
 * @class AsperaApi
 * @extends {BaseAPI}
 */
export default class AsperaApi extends BaseAPI {
    customdata: CustomdataApi;
    constructor(configuration: Configuration);
    /**
     * @summary Create Aspera Input
     * @param {AsperaInput} asperaInput The Aspera input to be created
     * @throws {BitmovinError}
     * @memberof AsperaApi
     */
    create(asperaInput?: AsperaInput): Promise<AsperaInput>;
    /**
     * @summary Delete Aspera Input
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof AsperaApi
     */
    delete(inputId: string): Promise<AsperaInput>;
    /**
     * @summary Aspera Input Details
     * @param {string} inputId Id of the input
     * @throws {BitmovinError}
     * @memberof AsperaApi
     */
    get(inputId: string): Promise<AsperaInput>;
    /**
     * @summary List Aspera Inputs
     * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
     * @throws {BitmovinError}
     * @memberof AsperaApi
     */
    list(queryParameters?: AsperaInputListQueryParams | ((q: AsperaInputListQueryParamsBuilder) => AsperaInputListQueryParamsBuilder)): Promise<PaginationResponse<AsperaInput>>;
}